Subscription

Create Subscription

Authorization

apiKey

x-api-key<token>

Your Chargeflow API key. Generate it in the Developer Hub under Settings.

In: header

Path Parameters

disputeId*string

The unique Chargeflow object identifier of the dispute.

Match^[0-9a-fA-F]{24}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Creates a new Chargeflow subscription.

source_id*string

The unique subscription identifier appears on the source from which the subscription originated.

Lengthlength <= 128

account_id?string

The unique Chargeflow account identifier to which the subscription belongs. This field is required for platform users.

Match^[0-9a-fA-F]{24}$

created_at*string

The time at which the subscription was created at the source in ISO 8601 format.

Formatdate-time

start_date*string

The time at which the subscription was started at the source in ISO 8601 format.

Formatdate-time

frequency*string

The frequency at which a subscription is billed.

Value in

"day"
"week"
"month"
"year"

frequency_count*integer

The number of intervals per billing cycle. For example, if frequency = month and frequency_count = 1, the subscription renews every month. If frequency_count = 3, the subscription renews every three months.

Range1 <= value

collection_method?string

The billing method for the subscription.

Default"automatically"

Value in

"automatically"
"automatically_with_reminder"
"send_invoice"

updated_at?|

The time at which the subscription was updated at the source in ISO 8601 format.

Formatdate-time

end_date?|

The time at which the subscription was ended at the source in ISO 8601 format.

Formatdate-time

cancellation_date?|

The time at which the subscription was requested to be canceled at the source in ISO 8601 format. Returns null if a cancellation is never requested.

Formatdate-time

cancellation_reason?|

The submitted reason for why the subscription has canceled.

Value in

"too_expensive"
"low_quality"
"unused"
"too_complex"
"missing_features"

trial_start?|

The time at which the trial of the subscription began at the source in ISO 8601 format. Returns null if no trial is offered or if the trial was not utilized.

Formatdate-time

trial_end?|

The time at which the trial of the subscription ended at the source in ISO 8601 format. Returns null if no trial is offered or if the trial was not utilized.

Formatdate-time

renews_at?|

The time at which the subscription cycle renews at the source in ISO 8601 format. Returns null if the subscription has been canceled.

Formatdate-time

plan_name?|

The name of the plan associated with the subscription, representing the specific offering or service tier the subscriber is enrolled in.

pricing_model?string

The pricing model associated with the subscription.

Default"fixed_price"

Value in

"fixed_price"
"usage_base"

status?string

The current status of the subscription.

Default"active"

Value in

"active"
"inactive"
"canceled"

Response Body

`application/json`

curl -X POST "https://example.com/public/2025-04-01/disputes/string/subscription" \  -H "Content-Type: application/json" \  -d '{    "source_id": "string",    "created_at": "2019-08-24T14:15:22Z",    "start_date": "2019-08-24T14:15:22Z",    "frequency": "day",    "frequency_count": 1  }'

{  "id": "string",  "source_id": "string",  "account_id": "string",  "ext_account_id": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "start_date": "2019-08-24T14:15:22Z",  "end_date": "2019-08-24T14:15:22Z",  "cancellation_date": "2019-08-24T14:15:22Z",  "frequency": "day",  "frequency_count": 1,  "cancellation_reason": "too_expensive",  "collection_method": "automatically",  "trial_start": "2019-08-24T14:15:22Z",  "trial_end": "2019-08-24T14:15:22Z",  "renews_at": "2019-08-24T14:15:22Z",  "plan_name": "string",  "pricing_model": "fixed_price",  "status": "active"}

Subscription

Create Subscription

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`