Create

post https://{defaultHost}/v1/subscriptions

Creates a new subscription.

Response

Response body

object

string | null

The UUID of the specific object.

object

string

A string describing the object type returned.

ad_hoc_amount

integer | null

The amount to use for this subscription when the associated price is ad_hoc=true.

affiliation_expires_at

integer | null

Time at which the affiliation will expire.

cancel_at_period_end

boolean

If the subscription is set to cancel at the end of the current period. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.

live_mode

boolean

Set to true if this subscription is in live mode, and set to false if it is in test mode.

manual_payment

boolean

Whether or not this subscription should finalize checkouts during renewal with the manual_payment=true option.

quantity

integer

The quantity of products being purchased.

restore_at

integer | null

The time at which this subscription will automatically be restored. This can only be set if the subscription is canceled or set to cancel at period end.

tax_enabled

boolean

Whether or not tax is enabled for this subscription. This will default to the account's tax_protocol.tax_enabled value when the subscription is created.

trial_end_at

integer | null

If the subscription has a trial, the end of that trial.

metadata

object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Has additional fields

current_period_end_at

integer | null

End of the current period that the subscription is in. At the end of this period, a new period will be created. This will be null when the subscription has a one-time price.

current_period_start_at

integer | null

Start of the current period that the subscription is in.

ended_at

integer | null

If the subscription has ended, the date the subscription ended.

finite

boolean

Whether or not this subscription belongs to a price with a set recurring_period_count, meaning it has a defined end.

pending_update

object

price

string

The UUID of the price this subscription will be updated to at the end of the current period.

quantity

integer

The quantity of products being purchased at the end of the current period.

portal_url

string | null

A URL that will redirect to this subscription's correct portal page (hosted or external).

remaining_period_count

integer | null

The number of periods remaining before this subscription ends. This count is reduced when a period is paid.

subtotal_amount

integer

Total of the subscription before discounts or taxes are applied.

status

string

The current status of this subscription, which can be one of incomplete, trialing, active, past_due, canceled, or completed.

affiliation

object | null

The affiliation associated with this subscription.

Has additional fields

current_cancellation_act

string | null

The associated current cancellation act.

current_period

string

The associated current period.

customer

string

The associated customer.

discount

string | null

The associated discount.

manual_payment_method

string | null

The associated manual payment method.

payment_method

string | null

The associated payment method.

periods

object | null

The associated periods.

Has additional fields

price

string

The associated price.

purchase

string | null

The associated purchase.

shipping_method

string | null

The associated shipping_method.

variant

string | null

The associated variant.

variant_options

array | null

An array of the associated variant's options.

variant_options

created_at

integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

updated_at

integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.surecart.com/v1/subscriptions \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

200Success