Create Subscription

POST

/v1/billing/subscriptions/

Create a subscription record. Typically called by Paddle webhook handler.

Request Body ^required

SubscriptionCreate

Fields required to create a Subscription record.

Typically written by the Paddle webhook handler on subscription.created / subscription.activated events.

object

paddle_subscription_id

required

Paddle Subscription Id

string

paddle_customer_id

required

Paddle Customer Id

string

paddle_plan_id

required

Paddle Plan Id

string

paddle_status

required

Paddle Status

string

plan_name

required

Plan Name

string

is_free_trial

Is Free Trial

boolean

start_date

required

Start Date

string format: date-time

end_date

Any of:

string

string format: date-time

null

null

auto_renew

Auto Renew

boolean

default: true

cancelled_at

Any of:

string

string format: date-time

null

null

billing_cycle

required

Billing Cycle

string

per_cycle_billing_amount

required

Per Cycle Billing Amount

integer

billing_address_line_1

required

Billing Address Line 1

string

>= 1 characters <= 255 characters

billing_address_line_2

Any of:

string

string

<= 255 characters

null

null

billing_city

required

Billing City

string

>= 1 characters <= 100 characters

billing_state

required

Billing State

string

>= 1 characters <= 100 characters

billing_zip

required

Billing Zip

string

>= 1 characters <= 20 characters

billing_country

required

Billing Country

string

>= 1 characters <= 100 characters

billing_email

required

Billing Email

string format: email

billing_phone

required

Billing Phone

string

>= 1 characters <= 50 characters

billing_contact_name

required

Billing Contact Name

string

>= 1 characters <= 255 characters

send_invoice_days_before_due

Send Invoice Days Before Due

integer

0

send_email_receipts

Send Email Receipts

boolean

default: true

send_paper_receipts

Send Paper Receipts

boolean

Responses

201

Successful Response

Response[SubscriptionRead]

object

data

required

SubscriptionRead

Full representation of a Subscription record.

object

id

required

Id

string format: uuid

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

paddle_subscription_id

required

Paddle Subscription Id

string

paddle_customer_id

required

Paddle Customer Id

string

paddle_plan_id

required

Paddle Plan Id

string

paddle_status

required

Paddle Status

string

plan_name

required

Plan Name

string

is_free_trial

required

Is Free Trial

boolean

start_date

required

Start Date

string format: date-time

end_date

Any of:

string

string format: date-time

null

null

auto_renew

required

Auto Renew

boolean

cancelled_at

Any of:

string

string format: date-time

null

null

billing_cycle

required

Billing Cycle

string

per_cycle_billing_amount

required

Per Cycle Billing Amount

integer

billing_address_line_1

required

Billing Address Line 1

string

billing_address_line_2

Any of:

string

string

null

null

billing_city

required

Billing City

string

billing_state

required

Billing State

string

billing_zip

required

Billing Zip

string

billing_country

required

Billing Country

string

billing_email

required

Billing Email

string

billing_phone

required

Billing Phone

string

billing_contact_name

required

Billing Contact Name

string

send_invoice_days_before_due

required

Send Invoice Days Before Due

integer

send_email_receipts

required

Send Email Receipts

boolean

send_paper_receipts

required

Send Paper Receipts

boolean

meta

ResponseMeta

Metadata included in every response envelope.

object

request_id

Any of:

string

string

null

null

organization_id

Any of:

string

string

null

null

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object