Go to Chargeflow Account
GuidesAPI Reference
API Reference
Start typing to search…

Create Subscription

post
https://api.chargeflow.io/public/2025-04-01/disputes//subscription

Creates a subscription in Chargeflow that can be used to enrich a dispute.

Path Params
string
required

The unique Chargeflow object identifier of the dispute.

Body Params
string
required
length ≤ 128

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

string

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

date-time
required

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

date-time
required

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

string
enum
required

The frequency at which a subscription is billed.

Allowed:
integer
required
≥ 1

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.

string
enum
Defaults to automatically

The billing method for the subscription.

Allowed:
date-time | null

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

date-time | null

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

date-time | null

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.

string | null
enum

The submitted reason for why the subscription has canceled.

Allowed:
date-time | null

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.

date-time | null

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.

date-time | null

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

string | null

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

string
enum
Defaults to fixed_price

The pricing model associated with the subscription.

Allowed:
string
enum
Defaults to active

The current status of the subscription.

Allowed:
Responses

Updated 6 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago