Skip to main content
Log inSign up
Anchor to subscriptionContract

subscriptionContract

query

Returns a Subscription Contract resource by ID.

ID!required

The ID of the Subscription Contract to return.


Was this section helpful?

Anchor to SubscriptionContractSubscriptionContract

Represents a Subscription Contract.

app

The subscription app that the subscription contract is registered to.

appAdminUrl

The URL of the subscription contract page on the subscription app.

billingAttempts
non-null

The list of billing attempts associated with the subscription contract.

billingPolicy
non-null

The billing policy associated with the subscription contract.

createdAt
non-null

The date and time when the subscription contract was created.

currencyCode
non-null

The currency that's used for the subscription contract.

customAttributes
non-null

A list of the custom attributes to be added to the generated orders.

customer

The customer to whom the subscription contract belongs.

customerPaymentMethod

The customer payment method that's used for the subscription contract.

deliveryMethod

The delivery method for each billing of the subscription contract.

deliveryPolicy
non-null

The delivery policy associated with the subscription contract.

deliveryPrice
non-null

The delivery price for each billing of the subscription contract.

discounts
non-null

The list of subscription discounts associated with the subscription contract.

id
non-null

A globally-unique ID.

lastBillingAttemptErrorType

The last billing error type of the contract.

lastPaymentStatus

The current status of the last payment.

lines
non-null

The list of subscription lines associated with the subscription contract.

linesCount

The number of lines associated with the subscription contract.

nextBillingDate

The next billing date for the subscription contract. This field is managed by the apps. Alternatively you can utilize our Billing Cycles APIs, which provide auto-computed billing dates and additional functionalities.

note

The note field that will be applied to the generated orders.

orders
non-null

A list of the subscription contract's orders.

originOrder

The order from which this contract originated.

revisionId
non-null

The revision id of the contract.

status
non-null

The current status of the subscription contract.

updatedAt
non-null

The date and time when the subscription contract was updated.

lineCount
non-nullDeprecated

The number of lines associated with the subscription contract. Use linesCount instead.


Was this section helpful?