Create Subscription

post

https://subs.api.recurlycommerce.com/api/v1/subscriptions

Create a subscription

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

deliveryCadenceCount

number

required

deliveryCadenceUnit

string

enum

required

Allowed:

billingCadenceCount

number

required

billingCadenceUnit

string

enum

required

Allowed:

customAttributes

array of objects

customAttributes

subscriberId

string

required

subscriptionOfferId

string

required

The internal id of the subscription plan (subscription offer) this subscription belongs to. Every line must belong to this plan.

deliveryFirstName

string

Required unless the subscription plan is digital-only (no shipping needed).

deliveryLastName

string

Required unless the subscription plan is digital-only (no shipping needed).

deliveryAddress1

string

Required unless the subscription plan is digital-only (no shipping needed).

deliveryAddress2

string | null

deliveryCountry

string

Required unless the subscription plan is digital-only (no shipping needed).

deliveryCountryCode

string

deliveryProvince

string | null

deliveryProvinceCode

string

deliveryCity

string

Required unless the subscription plan is digital-only (no shipping needed).

deliveryZip

string

Required unless the subscription plan is digital-only (no shipping needed).

deliveryPhone

string

The delivery phone number. Required unless the subscription plan is digital-only.

deliveryCompany

string | null

paymentMethodExternalId

string

required

The shopify payment method ID

lines

array of objects

required

lines*

discountCode

string | null

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Choose an example:

application/json

200Successfully created subscription contract