Subscription
A Subscription Contract.
Anchor to Fields and connectionsFields and connections
- Anchor to billingPolicybilling•Subscription
Policy Billing Policy!non-null The billing policy associated with the subscription contract.
- Anchor to createdAtcreated•Date
At Time!non-null The date and time when the subscription contract was created.
- Anchor to currencyCodecurrency•Currency
Code Code!non-null The currency used for the subscription contract.
- Anchor to customAttributescustom•[Attribute!]!non-null
Attributes A list of custom attributes to be added to the generated orders.
- Anchor to deliveryMethoddelivery•Subscription
Method Delivery Method The delivery method for each billing of the subscription contract.
- Anchor to deliveryPolicydelivery•Subscription
Policy Delivery Policy!non-null The delivery policy associated with the subscription contract.
- Anchor to deliveryPricedelivery•Money
Price V2!non-null The delivery price for each billing of the subscription contract.
- •ID!non-nullPre-auth accessible
A globally-unique ID.
- Anchor to lastBillingAttemptErrorTypelast•Subscription
Billing Attempt Error Type Contract Last Billing Error Type The last billing error type of the contract.
- Anchor to lastPaymentStatuslast•Subscription
Payment Status Contract Last Payment Status The current status of the last payment.
- Anchor to lineslines•Subscription
Line Connection!non-null A list of subscription lines associated with the subscription contract.
- Anchor to linesCountlines•Count
Count The number of lines associated with the subscription contract.
- Anchor to nextBillingDatenext•Date
Billing Date Time The next billing date for the subscription contract.
- Anchor to notenote•String
A note that will be applied to the generated orders.
- Anchor to ordersorders•Order
Connection!non-null A list of the subscription contract's orders.
- Anchor to originOrderorigin•Order
Order The order from which the contract originated.
- Anchor to revisionIdrevision•Unsigned
Id Int64!non-null The revision ID of the contract.
- Anchor to statusstatus•Subscription
Contract Subscription Status!non-null The current status of the subscription contract.
- Anchor to upcomingBillingCyclesupcoming•Subscription
Billing Cycles Billing Cycle Connection!non-null The upcoming billing cycles on the subscription contract.
- Anchor to updatedAtupdated•Date
At Time!non-null The date and time when the subscription contract was updated.
Anchor to MutationsMutations
- •mutation
Activates a Subscription Contract. Contract status must be either active, paused, or failed.
- Anchor to subscriptionContractIdsubscription•ID!required
Contract Id The ID of the subscription contract to activate.
Arguments
- Anchor to contractcontract•Subscription
Contract The activated Subscription Contract.
- Anchor to userErrorsuser•[Subscription
Errors Contract Status Update User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Cancels a Subscription Contract.
- Anchor to subscriptionContractIdsubscription•ID!required
Contract Id The ID of the Subscription Contract to cancel.
Arguments
- Anchor to contractcontract•Subscription
Contract The canceled Subscription Contract.
- Anchor to userErrorsuser•[Subscription
Errors Contract Status Update User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Pauses a Subscription Contract.
- Anchor to subscriptionContractIdsubscription•ID!required
Contract Id The ID of the subscription contract to pause.
Arguments
- Anchor to contractcontract•Subscription
Contract The updated Subscription Contract after the pause operation.
- Anchor to userErrorsuser•[Subscription
Errors Contract Status Update User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Selects an option from a delivery options result and updates the delivery method on a Subscription Contract.
- Anchor to deliveryMethodInputdelivery•Subscription
Method Input Delivery Method Input!required The delivery method selected for the subscription contract.
- Anchor to subscriptionContractIdsubscription•ID!required
Contract Id The ID of the subscription contract.
- Anchor to subscriptionDeliveryOptionsResultTokensubscription•String!required
Delivery Options Result Token The token associated with the successfully fetched delivery options result for the subscription contract.
Arguments
- Anchor to contractcontract•Subscription
Contract The updated subscription contract object.
- Anchor to userErrorsuser•[Subscription
Errors Contract User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields