Create a subscription

post

https://api.piriod.com/subscriptions/

Creates a new Subscription object.

Body Params

customer

string

required

ID of related Customer object.

collection_scheme

string

Defaults to send_invoice

Defines how the subscription should be processed, whether it should first create the invoice or first attempt to charge the customer's card. One of charge_payment, send_invoice

billing_cycles

int32

The number of billing cycles this subscription must have. If it is empty the subscription will not be terminated automatically.

date_start

date

required

Date for the start of the subscription.

document

string

required

The ID of the document type this subscription should create.

expiration_days

int32

Defaults to 10

Limit days to wait for subscription payment before starting to send payment reminders.

lines

array of objects

required

A list of Subscription Line objects.

lines*

addons

array

A list of Subscription Addon objects.

addons

coupon

string

ID of related Coupon object. Must be compatible with apply_on=subscription.

note

string

A simple text with a 100 characters as max length.

references

array of objects

Reference documents that must be added to the invoices created by this subscription.

references

test_mode

boolean

Defaults to false

True or false if the subscription is to be created to account test environment.

Response

201201