Create a Subscription

post

https://testapi.payarc.net/v1/subscriptions

This API creates a subscription.

Body Params

customer_id

string

required

An ID against which a new subscription will be created.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Notes
Alphanumeric	Provide `customer_id` that was created using the Create a Customer API.

plan_id

string

required

An plan ID against which a new subscription is created.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Notes
Alphanumeric and Special Characters	Provide `plan_id` that was created using the Create a Plan API.

start_after_days

int32

Days after which the subscription will start.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Min Length	Max Length
Numeric	1	365

trial_days

int32

Number of days until the subscription is under the trial period.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Min Length	Max Length	Examples
Numeric	0	365	Created at: 2021-05-05 Trial Days: 3 What it means? Your billing for the subscription will start from 2021-05-08 till the end of the subscription period.

end_after_cycles

int32

Number of cycles after which a subscription will end.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Min Length	Max Length
Numeric	1	999

discount_id

string

An ID that refers to a coupon when applying to a subscription.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Notes
Alphanumeric and Special Characters	Provide `discount_id` that was created using the Create a Coupon API.

billing_type

int32

The type of billing applied to a subscription.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Default	Min Length	Max Length	Notes
Boolean	1	0	1	`1` represents billing type is 'Automatic' where you will be charged with the default card on file. `0` represents customer billing type is 'Manual' where you will receive a payment link over an email.

payment_due_days

int32

Number of days the payment is due after the invoice is sent.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Min Length	Max Length	Examples	Notes
Numeric	1 digit	2 digits	`3`, `23`	This field is required if `billing_type` is 0.

description

string

An arbitrary string that describes a subscription.
td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }

Format	Min Length	Max Length	Examples
Alphanumeric and Special Characters	5 characters	200 characters	`A1 Company 888-888-8888`

Headers

string

required

Defaults to application/json

Indicates which content types, expressed as MIME types, the client is able to understand.

Content-Type

string

required

Defaults to application/json

Indicates the media type of the resource sent in the HTTP message body.

Possible Values:
application/json
application/x-www-form-urlencoded

Responses

201201

422422