/api/v1/subscriptions

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

deliveryFirstName

string

required

deliveryLastName

string

required

deliveryAddress1

string

required

deliveryAddress2

string | null

deliveryCountry

string

required

deliveryCountryCode

string

required

deliveryProvince

string | null

required

deliveryProvinceCode

string

required

deliveryCity

string

required

deliveryZip

string

required

deliveryPhone

string

required

The delivery phone number

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