Retrieves a list of all contracts for the given customer Id

get https://sandbox.billwerk.com/api/v1/customers/{customerId}/contracts

Responses

Response body

array of objects

object

string | null

Unique ID.

LastBillingDate

date-time | null

Date where the last billing has happened.

NextBillingDate

date-time | null

Date when the next billing will happen.

PlanId

string | null

ID of the Plan in currently active phase.

CustomerId

string | null

ID of the Customer.

LifecycleStatus

string

Undefined Draft InOrderProcess InTrial TrialExpired Active Ended TemporarilyInactive Annulled Locked Paused Cancelled WrittenOff

TrialEndDate

date-time | null

Date when the trial phase will end.

CustomerName

string | null

Name of the Customer.

CustomerIsLocked

boolean

Determines if the Customer is locked.

Phases

array of objects | null

List of ContractPhases.

Phases

object

Type

string

Inactive Normal Trial

StartDate

date-time

Starting date of the contractphase.

PlanVariantId

string | null

ID of the PlanVariant.

PlanId

string | null

ID of the Plan.

Quantity

int32 | null

InheritStartDate

boolean

ExternalBillingReceiptId

string | null

ExternalBillingType

string

AmazonIap AppleIap GoogleIap RokuPay

Balance

double

Balance of the Contract.

ReferenceCode

string | null

Reference code of the Contract.

Currency

string | null

Currency of the Contract.

PlanGroupId

string | null

ID of the PlanGroup.

PriceListId

string | null

ID of the PriceList.

PaymentBearer

object

Represents detailed data required for payment

PaymentProvider

string | null

Used payment provider.

PaymentProviderRole

string | null

Used payment provider role.

InitialPaymentProviderRole

string | null

Used initial payment provider role.

EscalationSuspended

boolean

Determines if the escalation is suspended.

RecurringPaymentsPaused

boolean

Determines if recurring payments are paused.

CurrentPhase

object

PaymentProviderSupportRefunds

boolean

Determines if the payment provider supports refunds.

CurrentDunning

object

BillingSuspended

boolean

Determines if the billing is suspended.

ThresholdBillingDisabled

boolean

Determines if the threshold billing is disabled.

PrepaidCardsAmountRemaining

double | null

Amount remained on prepaid cards.

ExternalId

string | null

ID of the external Contract.

SalesEntityId

string | null

ID of the sales entity.

DeletionRequestedAt

date-time | null

The date when deletion has been requested.

AdditionalAddresses

array of objects | null

AdditionalAddresses

object

string | null

FirstName

string | null

LastName

string | null

CompanyName

string | null

AddressLine1

string | null

AddressLine2

string | null

Street

string | null

HouseNumber

string | null

PostalCode

string | null

City

string | null

State

string | null

Country

string

required

length between 2 and 2

The 2-letter ISO country code in capital letters, e.g. DE

FormattedStreetAddressLine

string | null

FormattedCityAddressLine

string | null

StartDate

date-time

Optional - Date when the Contract starts.

EndDate

date-time | null

Optional - Date when the Contract ends.

BilledUntil

date-time | null

Optional - Date until when the Contract has been billed.

PlanVariantId

string | null

ID of the PlanVariant.

Notes

string | null

Contains previously set notes.

PaymentMethod

string | null

Used payment method.

MandateReference

string | null

Mandat reference - in case of direct debit.

MandateSignatureDate

date-time | null

Date of signing the mandate.

DestinationCountry

string | null

Contract destination country.

CustomFields

object | null

Custom fields of the Contract.

Has additional fields

OnAccountDueAfter

object

ShippingAddressId

string | null

401

Unauthorized

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox.billwerk.com/api/v1/customers/customerId/contracts \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

404Not Found