Skip to main content
POST
Create subscription

Body

application/json

Subscription data

name
string
required

Subscription name

Example:

"Monthly Premium"

customer_id
string
required

Customer hash ID

Example:

"abc123def456"

mollie_profile_id
string
required

Mollie profile ID

Example:

"pfl_abc123"

mollie_mandate_id
string
required

Mollie mandate ID

Example:

"mdt_abc123"

start_date
string
required

Start date (Y-m-d)

Example:

"2025-02-01"

rules
object[]
required

Subscription rules

workflow_id
string

Invoice workflow ID (required for Moneybird)

Example:

"wf_123"

docstyle_id
string

Document style ID (required for Moneybird)

Example:

"ds_123"

Response

Subscription details

id
string
required
Example:

"sub_abc123"

name
string
required
Example:

"Monthly Premium"

status
enum<string>
required
Available options:
draft,
active,
paused,
cancelled,
completed
Example:

"active"

start_date
string
required
Example:

"2025-01-01"

created_at
string
required
Example:

"2025-01-01 10:00:00"

mollie_mandate_id
string
Example:

"mdt_abc123"

mollie_profile_id
string
Example:

"pfl_abc123"

next_payment_at
string | null
Example:

"2025-02-01"

next_amount
string | null
Example:

"29.99"

last_payment_created_at
string | null
Example:

"2025-01-01 10:00:00"

resume_at
string | null
Example:

"2025-03-01"

cancel_at
string | null
Example:

"2025-12-31"

rules
object[]
customer
object