Anchor to section titled 'undefined'

SubscriptionContract
object

Requires the read_own_subscription_contracts or write_own_subscription_contracts scope.

Represents a Subscription Contract.


The subscription app that the subscription contract is registered to.

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

The list of billing attempts associated with the subscription contract.

The billing policy associated with the subscription contract.

The date and time when the subscription contract was created.

The currency that's used for the subscription contract.

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

The customer to whom the subscription contract belongs.

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

The delivery method for each billing of the subscription contract.

The delivery policy associated with the subscription contract.

The delivery price for each billing of the subscription contract.

The list of subscription discounts associated with the subscription contract.

A globally-unique ID.

The current status of the last payment.

The list of subscription lines associated with the subscription contract.

The number of lines associated with the subscription contract.

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.

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

A list of the subscription contract's orders.

The order from which this contract originated.

The revision id of the contract.

The current status of the subscription contract.

The date and time when the subscription contract was updated.


Was this section helpful?
Map

Fields and connections from

SubscriptionContract


Returns a Subscription Contract resource by ID.

List Subscription Contracts.


Was this section helpful?
<?>
SubscriptionContract Queries
SubscriptionContract


Activates a Subscription Contract.

Creates a Subscription Contract.

Cancels a Subscription Contract.

Expires a Subscription Contract.

Fails a Subscription Contract.

Pauses a Subscription Contract.

Allows for the easy change of a Product in a Contract or a Product price change.

Sets the next billing date of a 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.

Commits the updates of a Subscription Contract draft.


Was this section helpful?

||-
SubscriptionContract Implements
SubscriptionContract