Choose a version:

SubscriptionContract

object

A Subscription Contract.

Anchor to Fields and connectionsFields and connections

Anchor to createdAtcreatedAt •DateTime!non-null: The date and time when the subscription contract was created.
Anchor to idid •ID!non-nullPre-auth accessible: A globally-unique ID.
Anchor to lastPaymentStatuslastPaymentStatus •SubscriptionContractLastPaymentStatus: The current status of the last payment.
Anchor to nextBillingDatenextBillingDate •DateTime: The next billing date for the subscription contract.
Anchor to originOrderoriginOrder •Order: The order from which the contract originated.
Anchor to revisionIdrevisionId •UnsignedInt64!non-null: The revision ID of the contract.
Anchor to statusstatus •SubscriptionContractSubscriptionStatus!non-null: The current status of the subscription contract.
Anchor to upcomingBillingCyclesupcomingBillingCycles •SubscriptionBillingCycleConnection!non-null: The upcoming billing cycles on the subscription contract.

Was this section helpful?

•mutation

Activates a Subscription Contract. Contract status must be either active, paused, or failed.

Anchor to subscriptionContractIdsubscriptionContractId •ID!required: The ID of the subscription contract to activate.

Anchor to contractcontract •SubscriptionContract: The activated Subscription Contract.

•mutation

Cancels a Subscription Contract.

Anchor to subscriptionContractIdsubscriptionContractId •ID!required: The ID of the Subscription Contract to cancel.

Anchor to contractcontract •SubscriptionContract: The canceled Subscription Contract.

•mutation

Pauses a Subscription Contract.

Anchor to subscriptionContractIdsubscriptionContractId •ID!required: The ID of the subscription contract to pause.

Anchor to contractcontract •SubscriptionContract: The updated Subscription Contract after the pause operation.

•mutation

Selects an option from a delivery options result and updates the delivery method on a Subscription Contract.

Anchor to subscriptionContractIdsubscriptionContractId •ID!required: The ID of the subscription contract.
Anchor to subscriptionDeliveryOptionsResultTokensubscriptionDeliveryOptionsResultToken •String!required: The token associated with the successfully fetched delivery options result for the subscription contract.

Anchor to contractcontract •SubscriptionContract: The updated subscription contract object.

Was this section helpful?

Was this section helpful?