SubscriptionFlow API Reference (1.0.0)

Download OpenAPI specification:Download

E-mail: [email protected] License: Apache 2.0

Developer reference for SubscriptionFlow API

Getting Started

SubscriptionFlow provides an HTTP-based API that follows the principles of REST. The HTTP rules followed allow simple HTTP clients like cURL to be used as well. The URLs are resource-oriented, the request format is form-encoded, and the responses are in JSON.

Depending on the type of operation, the endpoints use one of the following HTTP methods:

GET: Used for all read-only operations such as retrieving a resource or listing a group of resources.
POST: Used for all create operations. Such operations creates a resource.
PUT: Used for all update operations. Such operations modify the state of a resource.
DELETE: Used for all remove operations. Such as removing of a resource.

Using Postman for API Testing

We recommend using Postman for seamless testing and interaction with our APIs. To make your testing process even smoother, we have prepared a comprehensive collection of API requests in Postman.

Click the link above to import our collection into your Postman workspace. This collection includes pre-configured requests for various API endpoints, allowing you to easily explore and test the functionalities of our API.

Authentication

SubscriptionFlow uses authentication tokens for authorization of API requests. Follow these steps to obtain an authentication token:

Client Credentials: To get started, follow our [Client Credentials Guide] (https://support.subscriptionflow.com/hc/en-us/articles/900004667566-How-To-Use-OAuth-Client) to obtain your unique client_id and client_secret from your SubscriptionFlow (SF) instance.
Obtain an Auth Token: Once you have your client_id and client_secret, make a POST request to the OAuth endpoint with these credentials to obtain a bearer token. Your request should include the following:
- client_id: Your client ID.
- client_secret: Your client secret.
- Grant type: Use the "client_credentials" grant type to request an access token.

Example Request

curl --location --request POST 'http://{site}.subscriptionflow.com/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=your_client_id' \
--data-urlencode 'client_secret=your_client_secret' \
--data-urlencode 'grant_type=client_credentials'

Error Handling

SubscriptionFlow API provides error handling capabilities by using standard HTTP error codes and additional helpful parameters in its error responses. This page provides recommendations on effective error handling and a reference for all custom and standard error codes used by the API.

HTTP status codes are used to indicate success or failure of an API call. The body of the response contains the details of the error in JSON format.

The standard http status codes used are

2XX: The response code in this range implies the API call has succeeded.
3XX: This range is not used currently.
4XX: response codes indicate failure due to wrong input (i.e, client) side. As the usable list of http codes in the 4xx range is limited we predominantly use the 400 ( BAD REQUEST ) error code for client-side errors.
5XX: response codes indicate API request was valid but failed due to issues on the SubscriptionFlow server. The 500 ( INTERNAL SERVER ERROR ) error code is used for server-side errors.

Customers

Represents a customer, which can be an individual or organization that subscribes to your products or services. The customer resource associates with subscriptions, card information, and billing addresses. The customer details include their ID, name, contact information, and any custom attributes you'd like to associate with them

Get list of Customers

Retrieves a list of customers added to your SubscriptionFlow instance. The list contains the necessary customer details such as Name, Balance, and the Customer ID. You can use the Customer ID to retrieve the customer details.

Responses

Response Schema: application/json

	Array of objects
	object
	object

Response samples

Content type

application/json

{"data": [{"id": "User-12345",
"name": "SF DEVELOPERS",
"email": "[email protected]",
"company": "string",
"phone_number": "string",
"po_number": "string",
"legal_entity": "string",
"currency": "USD",
"billing_cycle_day": 0,
"notes": "string",
"image": "string",
"customer_number": "CUST_2",
"terms": "string",
"created_at": "2024-02-06T09:01:00+01:00",
"updated_at": "2024-06-07T15:35:00+02:00",
"portal_is_enabled": 1,
"tax_exempt": 0,
"certificate_id": "string",
"certificate_type": "string",
"issuing_jurisdiction": "string",
"entity_use_code": "string",
"description": "string",
"vat_id": "string",
"last_activity": "string",
"auto_charge": 1,
"billing_address_1": "string",
"billing_address_2": "string",
"billing_address_3": "string",
"billing_city": "string",
"billing_state": "string",
"billing_county": "string",
"billing_postal_code": "string",
"billing_country": "string",
"billing_name": "string",
"billing_email": "string",
"shipping_address_1": "string",
"shipping_address_2": "string",
"shipping_address_3": "string",
"shipping_city": "string",
"shipping_state": "string",
"shipping_county": "string",
"shipping_postal_code": "string",
"shipping_country": "string",
"shipping_name": "string",
"shipping_email": "string",
"data_source": "SubscriptionFlow",
"primary_churn_score_value": 0,
"primary_churn_score_grade": "string",
"miscellaneous_charges_exempt": "string",
"invoice_payer": "string",
"consolidate_invoices": "string"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"url": "http://example.com",
"label": "string",
"active": true
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Store a new Customer

Creates a customer. You can create a customer and then create subscriptions for the customer when required. When creating a customer, you can pass along the billing address and shipping address of the customer. You can also select the auto charge option to automatically charge the customer for the subscription.

Responses

Response samples

Content type

application/json

{"data": {"type": "customers",
"id": "3213427c-593d-458f-b18b-5562be90113d",
"attributes": {"id": "3213427c-593d-458f-b18b-5562be90113d",
"name": "Sybill",
"email": "[email protected]",
"company": null,
"phone_number": null,
"po_number": null,
"legal_entity": null,
"currency": "USD",
"billing_cycle_day": "1",
"notes": null,
"image": null,
"customer_number": "CUST_002648",
"terms": null,
"created_at": "2024-06-24T09:25:00+01:00",
"updated_at": "2024-06-24T09:25:00+01:00",
"portal_is_enabled": 1,
"tax_exempt": 0,
"certificate_id": null,
"certificate_type": null,
"issuing_jurisdiction": null,
"entity_use_code": null,
"description": null,
"vat_id": null,
"last_activity": "{{LBL_GENERATED_EMAIL}} [email protected]",
"auto_charge": 1,
"billing_address_1": null,
"billing_address_2": null,
"billing_address_3": null,
"billing_city": null,
"billing_state": null,
"billing_county": null,
"billing_postal_code": null,
"billing_country": null,
"billing_name": null,
"billing_email": null,
"shipping_address_1": null,
"shipping_address_2": null,
"shipping_address_3": null,
"shipping_city": null,
"shipping_state": null,
"shipping_county": null,
"shipping_postal_code": null,
"shipping_country": null,
"shipping_name": null,
"shipping_email": null,
"data_source": "SubscriptionFlow",
"primary_churn_score_value": null,
"primary_churn_score_grade": null,
"miscellaneous_charges_exempt": 0,
"invoice_payer": "Subscription_Customer",
"consolidate_invoices": "Never"
},
"relationships": {"parent_id": null,
"email": {"id": "9951eb81-961f-4359-b340-2aee328cd09b",
"link": "https://demo.subscriptionflow.com/api/v1/email-addresses/9951eb81-961f-4359-b340-2aee328cd09b"
},
"tax_company": null,
"created_by": {"id": "1",
"link": "https://demo.subscriptionflow.com/api/v1/users/1"
},
"updated_by": {"id": "1",
"link": "https://demo.subscriptionflow.com/api/v1/users/1"
},
"assigned_to": {"id": "1",
"link": "https://demo.subscriptionflow.com/api/v1/users/1"
},
"assigned_group_id": null,
"primary_churn_score_id": null
},
"links": {"self": "https://demo.subscriptionflow.com/api/v1/customers/3213427c-593d-458f-b18b-5562be90113d",
"app_url": "https://demo.subscriptionflow.com/customer-detail/3213427c-593d-458f-b18b-5562be90113d"
}
}
}

Retrieve a Customer

Retrieves the details of an existing customer. You need to pass the unique customer ID that was returned upon successful customer creation.

path Parameters

customer_id

required

string

The unique identifier for the customer.

Responses

Response Schema: application/json

object

Response samples

Content type

application/json

{"data": {"type": "customers",
"id": "3213427c-593d-458f-b18b-5562be90113d",
"attributes": {"id": "3213427c-593d-458f-b18b-5562be90113d",
"name": "Sybill",
"email": "[email protected]",
"company": null,
"phone_number": null,
"po_number": null,
"legal_entity": null,
"currency": "USD",
"billing_cycle_day": "1",
"notes": null,
"image": null,
"customer_number": "CUST_002648",
"terms": null,
"created_at": "2024-06-24T09:25:00+01:00",
"updated_at": "2024-06-24T09:25:00+01:00",
"portal_is_enabled": 1,
"tax_exempt": 0,
"certificate_id": null,
"certificate_type": null,
"issuing_jurisdiction": null,
"entity_use_code": null,
"description": null,
"vat_id": null,
"last_activity": "{{LBL_GENERATED_EMAIL}} [email protected]",
"auto_charge": 1,
"billing_address_1": null,
"billing_address_2": null,
"billing_address_3": null,
"billing_city": null,
"billing_state": null,
"billing_county": null,
"billing_postal_code": null,
"billing_country": null,
"billing_name": null,
"billing_email": null,
"shipping_address_1": null,
"shipping_address_2": null,
"shipping_address_3": null,
"shipping_city": null,
"shipping_state": null,
"shipping_county": null,
"shipping_postal_code": null,
"shipping_country": null,
"shipping_name": null,
"shipping_email": null,
"data_source": "SubscriptionFlow",
"primary_churn_score_value": null,
"primary_churn_score_grade": null,
"miscellaneous_charges_exempt": 0,
"invoice_payer": "Subscription_Customer",
"consolidate_invoices": "Never"
},
"relationships": {"parent_id": null,
"email": {"id": "9951eb81-961f-4359-b340-2aee328cd09b",
"link": "https://demo.subscriptionflow.com/api/v1/email-addresses/9951eb81-961f-4359-b340-2aee328cd09b"
},
"tax_company": null,
"created_by": {"id": "1",
"link": "https://demo.subscriptionflow.com/api/v1/users/1"
},
"updated_by": {"id": "1",
"link": "https://demo.subscriptionflow.com/api/v1/users/1"
},
"assigned_to": {"id": "1",
"link": "https://demo.subscriptionflow.com/api/v1/users/1"
},
"assigned_group_id": null,
"primary_churn_score_id": null
},
"links": {"self": "https://demo.subscriptionflow.com/api/v1/customers/3213427c-593d-458f-b18b-5562be90113d",
"app_url": "https://demo.subscriptionflow.com/customer-detail/3213427c-593d-458f-b18b-5562be90113d"
}
}
}

Update existing Customer

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the customer's billing address but not the shipping address, the customer's shipping address will be unaltered.

path Parameters

customer_id

required

string

The unique identifier for the customer.

Request Body schema: application/json

id	any <char> (Id) The unique identifier for the customer.
parent_id	any <char> (Parent Customer) The identifier of the parent customer if applicable.
name	any <varchar> (Name) The name of the customer.
phone_number	any <varchar> (Phone Number) The customer's contact number.
po_number	any <varchar> (PO Number) The customer's purchase order number.
legal_entity	any <varchar> (Legal Entity) The legal entity associated with the customer.
billing_cycle_day	any <varchar> (Billing Cycle Day) The day of the month when the customer's billing cycle starts.
notes	any <text> (Notes) Additional information about the customer.
image	any <varchar> (Image) The URL of an image for the customer.
customer_number	any <varchar> (Customer Number) The customer's number or ID.
terms	any <varchar> (Terms) The terms of payment for the customer.
created_at	any <timestamp> (Created At) The date and time when the customer was created.
updated_at	any <timestamp> (Updated At) The date and time when the customer was last updated.
deleted_at	any <timestamp> (Deleted At) The date and time when the customer was deleted.
portal_pass	any <varchar> (Portal Pass) The customer's portal password.
portal_email	any <varchar> (Portal Email) The customer's portal email address.
portal_is_enabled	any <tinyint> (Portal Is Enabled) Indicates whether the customer's portal is enabled.
last_successful_login	any <datetime> (Last Successful Login) The date and time when the customer last logged in to the portal.
last_failed_login	any <datetime> (Last Failed Login) The date and time when the customer last failed to log in to the portal.
tax_exempt	any <tinyint> (Tax Exempt) Indicates whether the customer is exempt from tax.
certificate_id	any <varchar> (Certificate ID) The customer's tax exemption certificate ID.
certificate_type	any <varchar> (Certificate Type) The customer's tax exemption certificate type.
issuing_jurisdiction	any <varchar> (Issuing Jurisdiction) The jurisdiction that issued the customer's tax exemption certificate.
entity_use_code	any <varchar> (Entity Use Code) The customer's entity use code.
description	any <text> (Description) The customer's description.
tax_company	any <char> (Tax Company) The customer's tax company.
vat_id	any <varchar> (VAT ID) The customer's VAT ID.
last_activity	any <varchar> (Last Activity) The date and time when the customer was last active.
created_by	any <char> (Created By) The user who created the customer.
updated_by	any <char> (Updated By) The user who last updated the customer.
assigned_to	any <char> (Assigned To) The user who is assigned to the customer.
assigned_group_id	any <char> (Assigned Group) The group that is assigned to the customer.
auto_charge	any <tinyint> (Auto Charge) Indicates whether the customer is automatically charged.
balance	any <number> (Outstanding Balance) The customer's outstanding balance.
unapplied_amount	any <number> (Unapplied Amount) The customer's unapplied amount.
billing_address_1	any <text> (Billing Address 1) The customer's billing address line 1.
billing_address_2	any <text> (Billing Address 2) The customer's billing address line 2.
billing_city	any <varchar> (Billing City) The customer's billing address city.
billing_state	any <varchar> (Billing State) The customer's billing address state.
billing_county	any <varchar> (Billing County) The customer's billing address county.
billing_postal_code	any <varchar> (Billing Postal Code) The customer's billing address postal code.
billing_country	any <varchar> (Billing Country) The customer's billing address country.
shipping_address_1	any <text> (Shipping Address 1) The customer's shipping address line 1.
shipping_address_2	any <text> (Shipping Address 2) The customer's shipping address line 2.
shipping_city	any <varchar> (Shipping City) The customer's shipping address city.
shipping_state	any <varchar> (Shipping State) The customer's shipping address state.
shipping_county	any <varchar> (Shipping County) The customer's shipping address county.
shipping_postal_code	any <varchar> (Shipping Postal Code) The customer's shipping address postal code.
shipping_country	any <varchar> (Shipping Country) The customer's shipping address country.
data_source	any <char> (Data Source) The data source of the customer.

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"parent_id": "__test__cs5VnHhSBWl7eY2bl",
"name": "Acme Corp",
"phone_number": "+1 (123) 456-7890",
"po_number": "PO12345",
"legal_entity": "Acme Corp Legal Entity",
"billing_cycle_day": "15",
"notes": "Important customer with special requirements.",
"image": "https://www.subscriptionflow.com/",
"customer_number": "12345",
"terms": "Net 30",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"deleted_at": "2020-01-01T00:00:00Z",
"portal_pass": "123456",
"portal_email": "[email protected]",
"portal_is_enabled": 1,
"last_successful_login": "2020-01-01T00:00:00Z",
"last_failed_login": "2020-01-01T00:00:00Z",
"tax_exempt": 0,
"certificate_id": "12345",
"certificate_type": "resale",
"issuing_jurisdiction": "California",
"entity_use_code": "A",
"description": "Important customer with special requirements.",
"tax_company": "__test__cs3VnHhSBWl7eY2bl",
"vat_id": "12345",
"last_activity": "2020-01-01T00:00:00Z",
"created_by": "__test__us3VnHhSBWl7eY2bl",
"updated_by": "__test__us3VnHhSBWl7eY2bl",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
"auto_charge": 0,
"balance": 0,
"unapplied_amount": 0,
"billing_address_1": "123 Main St.",
"billing_address_2": "Suite 100",
"billing_city": "San Francisco",
"billing_state": "CA",
"billing_county": "San Francisco",
"billing_postal_code": "94105",
"billing_country": "US",
"shipping_address_1": "123 Main St.",
"shipping_address_2": "Suite 100",
"shipping_city": "San Francisco",
"shipping_state": "CA",
"shipping_county": "San Francisco",
"shipping_postal_code": "94105",
"shipping_country": "US",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Response samples

Content type

application/json

{"data": {"type": "customers",
"id": "3213427c-593d-458f-b18b-5562be90113d",
"attributes": {"id": "3213427c-593d-458f-b18b-5562be90113d",
"name": "Sybill",
"email": "[email protected]",
"company": null,
"phone_number": null,
"po_number": null,
"legal_entity": null,
"currency": "USD",
"billing_cycle_day": "1",
"notes": null,
"image": null,
"customer_number": "CUST_002648",
"terms": null,
"created_at": "2024-06-24T09:25:00+01:00",
"updated_at": "2024-06-24T09:25:00+01:00",
"portal_is_enabled": 1,
"tax_exempt": 0,
"certificate_id": null,
"certificate_type": null,
"issuing_jurisdiction": null,
"entity_use_code": null,
"description": null,
"vat_id": null,
"last_activity": "{{LBL_GENERATED_EMAIL}} [email protected]",
"auto_charge": 1,
"billing_address_1": null,
"billing_address_2": null,
"billing_address_3": null,
"billing_city": null,
"billing_state": null,
"billing_county": null,
"billing_postal_code": null,
"billing_country": null,
"billing_name": null,
"billing_email": null,
"shipping_address_1": null,
"shipping_address_2": null,
"shipping_address_3": null,
"shipping_city": null,
"shipping_state": null,
"shipping_county": null,
"shipping_postal_code": null,
"shipping_country": null,
"shipping_name": null,
"shipping_email": null,
"data_source": "SubscriptionFlow",
"primary_churn_score_value": null,
"primary_churn_score_grade": null,
"miscellaneous_charges_exempt": 0,
"invoice_payer": "Subscription_Customer",
"consolidate_invoices": "Never"
},
"relationships": {"parent_id": null,
"email": {"id": "9951eb81-961f-4359-b340-2aee328cd09b",
"link": "https://demo.subscriptionflow.com/api/v1/email-addresses/9951eb81-961f-4359-b340-2aee328cd09b"
},
"tax_company": null,
"created_by": {"id": "1",
"link": "https://demo.subscriptionflow.com/api/v1/users/1"
},
"updated_by": {"id": "1",
"link": "https://demo.subscriptionflow.com/api/v1/users/1"
},
"assigned_to": {"id": "1",
"link": "https://demo.subscriptionflow.com/api/v1/users/1"
},
"assigned_group_id": null,
"primary_churn_score_id": null
},
"links": {"self": "https://demo.subscriptionflow.com/api/v1/customers/3213427c-593d-458f-b18b-5562be90113d",
"app_url": "https://demo.subscriptionflow.com/customer-detail/3213427c-593d-458f-b18b-5562be90113d"
}
}
}

Delete existing Customer

Remove a specific customer from the database. This operation requires the customer ID to identify and delete the customer.

path Parameters

customer_id

required

string

The unique identifier for the customer.

Responses

Response samples

Content type

application/json

{"data": {"type": "customers",
"id": "2f6382c7-b368-45d9-a740-78d426f097af",
"attributes": {"id": "2f6382c7-b368-45d9-a740-78d426f097af",
"name": "Madison Inc.",
"email": "",
"company": null,
"phone_number": null,
"po_number": null,
"legal_entity": null,
"currency": "USD",
"billing_cycle_day": 1,
"notes": null,
"image": null,
"customer_number": "CUST_002646",
"terms": null,
"created_at": "2024-06-21T10:40:00+01:00",
"updated_at": "2024-06-25T20:22:00+01:00",
"portal_is_enabled": 1,
"tax_exempt": 0,
"certificate_id": null,
"certificate_type": null,
"issuing_jurisdiction": null,
"entity_use_code": null,
"description": null,
"vat_id": null,
"last_activity": "{{LBL_COMPLETED_EVENT}}",
"auto_charge": 1,
"billing_address_1": null,
"billing_address_2": null,
"billing_address_3": null,
"billing_city": null,
"billing_state": null,
"billing_county": null,
"billing_postal_code": null,
"billing_country": null,
"billing_name": null,
"billing_email": null,
"shipping_address_1": null,
"shipping_address_2": null,
"shipping_address_3": null,
"shipping_city": null,
"shipping_state": null,
"shipping_county": null,
"shipping_postal_code": null,
"shipping_country": null,
"shipping_name": null,
"shipping_email": null,
"data_source": "SubscriptionFlow",
"primary_churn_score_value": null,
"primary_churn_score_grade": null,
"miscellaneous_charges_exempt": 0,
"invoice_payer": "Parent_Customer",
"consolidate_invoices": "Never"
}
},
"relationships": {"parent_id": null,
"email": null,
"tax_company": null,
"created_by": {"id": "1",
"link": "https://demo.subscriptionflow.com/api/v1/users/1"
},
"updated_by": {"id": "1",
"link": "https://demo.subscriptionflow.com/api/v1/users/1"
},
"assigned_to": {"id": "1",
"link": "https://demo.subscriptionflow.com/api/v1/users/1"
},
"assigned_group_id": null,
"primary_churn_score_id": {"id": "53300375-a94f-4dfa-a72a-b5d3dcb1089d",
"link": "N/A"
}
},
"links": {"self": "https://demo.subscriptionflow.com/api/v1/customers/2f6382c7-b368-45d9-a740-78d426f097af",
"app_url": "https://demo.subscriptionflow.com/customer-detail/2f6382c7-b368-45d9-a740-78d426f097af"
}
}

Get with-relations list of Customers

Returns list of Customers with all foreign keys

Responses

Response Schema: application/json

id	any <char> (Id) The unique identifier for the customer.
parent_id	any <char> (Parent Customer) The identifier of the parent customer if applicable.
name	any <varchar> (Name) The name of the customer.
phone_number	any <varchar> (Phone Number) The customer's contact number.
po_number	any <varchar> (PO Number) The customer's purchase order number.
legal_entity	any <varchar> (Legal Entity) The legal entity associated with the customer.
billing_cycle_day	any <varchar> (Billing Cycle Day) The day of the month when the customer's billing cycle starts.
notes	any <text> (Notes) Additional information about the customer.
image	any <varchar> (Image) The URL of an image for the customer.
customer_number	any <varchar> (Customer Number) The customer's number or ID.
terms	any <varchar> (Terms) The terms of payment for the customer.
created_at	any <timestamp> (Created At) The date and time when the customer was created.
updated_at	any <timestamp> (Updated At) The date and time when the customer was last updated.
deleted_at	any <timestamp> (Deleted At) The date and time when the customer was deleted.
portal_pass	any <varchar> (Portal Pass) The customer's portal password.
portal_email	any <varchar> (Portal Email) The customer's portal email address.
portal_is_enabled	any <tinyint> (Portal Is Enabled) Indicates whether the customer's portal is enabled.
last_successful_login	any <datetime> (Last Successful Login) The date and time when the customer last logged in to the portal.
last_failed_login	any <datetime> (Last Failed Login) The date and time when the customer last failed to log in to the portal.
tax_exempt	any <tinyint> (Tax Exempt) Indicates whether the customer is exempt from tax.
certificate_id	any <varchar> (Certificate ID) The customer's tax exemption certificate ID.
certificate_type	any <varchar> (Certificate Type) The customer's tax exemption certificate type.
issuing_jurisdiction	any <varchar> (Issuing Jurisdiction) The jurisdiction that issued the customer's tax exemption certificate.
entity_use_code	any <varchar> (Entity Use Code) The customer's entity use code.
description	any <text> (Description) The customer's description.
tax_company	any <char> (Tax Company) The customer's tax company.
vat_id	any <varchar> (VAT ID) The customer's VAT ID.
last_activity	any <varchar> (Last Activity) The date and time when the customer was last active.
created_by	any <char> (Created By) The user who created the customer.
updated_by	any <char> (Updated By) The user who last updated the customer.
assigned_to	any <char> (Assigned To) The user who is assigned to the customer.
assigned_group_id	any <char> (Assigned Group) The group that is assigned to the customer.
auto_charge	any <tinyint> (Auto Charge) Indicates whether the customer is automatically charged.
balance	any <number> (Outstanding Balance) The customer's outstanding balance.
unapplied_amount	any <number> (Unapplied Amount) The customer's unapplied amount.
billing_address_1	any <text> (Billing Address 1) The customer's billing address line 1.
billing_address_2	any <text> (Billing Address 2) The customer's billing address line 2.
billing_city	any <varchar> (Billing City) The customer's billing address city.
billing_state	any <varchar> (Billing State) The customer's billing address state.
billing_county	any <varchar> (Billing County) The customer's billing address county.
billing_postal_code	any <varchar> (Billing Postal Code) The customer's billing address postal code.
billing_country	any <varchar> (Billing Country) The customer's billing address country.
shipping_address_1	any <text> (Shipping Address 1) The customer's shipping address line 1.
shipping_address_2	any <text> (Shipping Address 2) The customer's shipping address line 2.
shipping_city	any <varchar> (Shipping City) The customer's shipping address city.
shipping_state	any <varchar> (Shipping State) The customer's shipping address state.
shipping_county	any <varchar> (Shipping County) The customer's shipping address county.
shipping_postal_code	any <varchar> (Shipping Postal Code) The customer's shipping address postal code.
shipping_country	any <varchar> (Shipping Country) The customer's shipping address country.
data_source	any <char> (Data Source) The data source of the customer.

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"parent_id": "__test__cs5VnHhSBWl7eY2bl",
"name": "Acme Corp",
"phone_number": "+1 (123) 456-7890",
"po_number": "PO12345",
"legal_entity": "Acme Corp Legal Entity",
"billing_cycle_day": "15",
"notes": "Important customer with special requirements.",
"image": "https://www.subscriptionflow.com/",
"customer_number": "12345",
"terms": "Net 30",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"deleted_at": "2020-01-01T00:00:00Z",
"portal_pass": "123456",
"portal_email": "[email protected]",
"portal_is_enabled": 1,
"last_successful_login": "2020-01-01T00:00:00Z",
"last_failed_login": "2020-01-01T00:00:00Z",
"tax_exempt": 0,
"certificate_id": "12345",
"certificate_type": "resale",
"issuing_jurisdiction": "California",
"entity_use_code": "A",
"description": "Important customer with special requirements.",
"tax_company": "__test__cs3VnHhSBWl7eY2bl",
"vat_id": "12345",
"last_activity": "2020-01-01T00:00:00Z",
"created_by": "__test__us3VnHhSBWl7eY2bl",
"updated_by": "__test__us3VnHhSBWl7eY2bl",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
"auto_charge": 0,
"balance": 0,
"unapplied_amount": 0,
"billing_address_1": "123 Main St.",
"billing_address_2": "Suite 100",
"billing_city": "San Francisco",
"billing_state": "CA",
"billing_county": "San Francisco",
"billing_postal_code": "94105",
"billing_country": "US",
"shipping_address_1": "123 Main St.",
"shipping_address_2": "Suite 100",
"shipping_city": "San Francisco",
"shipping_state": "CA",
"shipping_county": "San Francisco",
"shipping_postal_code": "94105",
"shipping_country": "US",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Get related list of Customers

Returns one-to-many list of Customers with related Module

path Parameters

customer_id required	string The unique identifier for the customer.
related required	varchar The name of the relation you want to link with customers query. hasMany relation name

Responses

Response Schema: application/json

Array of objects

Response samples

Content type

application/json

{"data": [{"emailable_id": "3213427c-593d-458f-b18b-5562be90113d",
"emailable_type": "Modules\\\\Customers\\\\Entities\\\\Customer",
"email": "[email protected]",
"primary": 1,
"invalid": 0,
"opt_out": 0
}
]
}

Get filtered list of Customers

Returns list of Customers with quick filters

path Parameters

fieldName

required

varchar

Field name to apply filter E.g. 'name' = 'John'

Responses

Response Schema: application/json

id	any <char> (Id) The unique identifier for the customer.
parent_id	any <char> (Parent Customer) The identifier of the parent customer if applicable.
name	any <varchar> (Name) The name of the customer.
phone_number	any <varchar> (Phone Number) The customer's contact number.
po_number	any <varchar> (PO Number) The customer's purchase order number.
legal_entity	any <varchar> (Legal Entity) The legal entity associated with the customer.
billing_cycle_day	any <varchar> (Billing Cycle Day) The day of the month when the customer's billing cycle starts.
notes	any <text> (Notes) Additional information about the customer.
image	any <varchar> (Image) The URL of an image for the customer.
customer_number	any <varchar> (Customer Number) The customer's number or ID.
terms	any <varchar> (Terms) The terms of payment for the customer.
created_at	any <timestamp> (Created At) The date and time when the customer was created.
updated_at	any <timestamp> (Updated At) The date and time when the customer was last updated.
deleted_at	any <timestamp> (Deleted At) The date and time when the customer was deleted.
portal_pass	any <varchar> (Portal Pass) The customer's portal password.
portal_email	any <varchar> (Portal Email) The customer's portal email address.
portal_is_enabled	any <tinyint> (Portal Is Enabled) Indicates whether the customer's portal is enabled.
last_successful_login	any <datetime> (Last Successful Login) The date and time when the customer last logged in to the portal.
last_failed_login	any <datetime> (Last Failed Login) The date and time when the customer last failed to log in to the portal.
tax_exempt	any <tinyint> (Tax Exempt) Indicates whether the customer is exempt from tax.
certificate_id	any <varchar> (Certificate ID) The customer's tax exemption certificate ID.
certificate_type	any <varchar> (Certificate Type) The customer's tax exemption certificate type.
issuing_jurisdiction	any <varchar> (Issuing Jurisdiction) The jurisdiction that issued the customer's tax exemption certificate.
entity_use_code	any <varchar> (Entity Use Code) The customer's entity use code.
description	any <text> (Description) The customer's description.
tax_company	any <char> (Tax Company) The customer's tax company.
vat_id	any <varchar> (VAT ID) The customer's VAT ID.
last_activity	any <varchar> (Last Activity) The date and time when the customer was last active.
created_by	any <char> (Created By) The user who created the customer.
updated_by	any <char> (Updated By) The user who last updated the customer.
assigned_to	any <char> (Assigned To) The user who is assigned to the customer.
assigned_group_id	any <char> (Assigned Group) The group that is assigned to the customer.
auto_charge	any <tinyint> (Auto Charge) Indicates whether the customer is automatically charged.
balance	any <number> (Outstanding Balance) The customer's outstanding balance.
unapplied_amount	any <number> (Unapplied Amount) The customer's unapplied amount.
billing_address_1	any <text> (Billing Address 1) The customer's billing address line 1.
billing_address_2	any <text> (Billing Address 2) The customer's billing address line 2.
billing_city	any <varchar> (Billing City) The customer's billing address city.
billing_state	any <varchar> (Billing State) The customer's billing address state.
billing_county	any <varchar> (Billing County) The customer's billing address county.
billing_postal_code	any <varchar> (Billing Postal Code) The customer's billing address postal code.
billing_country	any <varchar> (Billing Country) The customer's billing address country.
shipping_address_1	any <text> (Shipping Address 1) The customer's shipping address line 1.
shipping_address_2	any <text> (Shipping Address 2) The customer's shipping address line 2.
shipping_city	any <varchar> (Shipping City) The customer's shipping address city.
shipping_state	any <varchar> (Shipping State) The customer's shipping address state.
shipping_county	any <varchar> (Shipping County) The customer's shipping address county.
shipping_postal_code	any <varchar> (Shipping Postal Code) The customer's shipping address postal code.
shipping_country	any <varchar> (Shipping Country) The customer's shipping address country.
data_source	any <char> (Data Source) The data source of the customer.

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"parent_id": "__test__cs5VnHhSBWl7eY2bl",
"name": "Acme Corp",
"phone_number": "+1 (123) 456-7890",
"po_number": "PO12345",
"legal_entity": "Acme Corp Legal Entity",
"billing_cycle_day": "15",
"notes": "Important customer with special requirements.",
"image": "https://www.subscriptionflow.com/",
"customer_number": "12345",
"terms": "Net 30",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"deleted_at": "2020-01-01T00:00:00Z",
"portal_pass": "123456",
"portal_email": "[email protected]",
"portal_is_enabled": 1,
"last_successful_login": "2020-01-01T00:00:00Z",
"last_failed_login": "2020-01-01T00:00:00Z",
"tax_exempt": 0,
"certificate_id": "12345",
"certificate_type": "resale",
"issuing_jurisdiction": "California",
"entity_use_code": "A",
"description": "Important customer with special requirements.",
"tax_company": "__test__cs3VnHhSBWl7eY2bl",
"vat_id": "12345",
"last_activity": "2020-01-01T00:00:00Z",
"created_by": "__test__us3VnHhSBWl7eY2bl",
"updated_by": "__test__us3VnHhSBWl7eY2bl",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
"auto_charge": 0,
"balance": 0,
"unapplied_amount": 0,
"billing_address_1": "123 Main St.",
"billing_address_2": "Suite 100",
"billing_city": "San Francisco",
"billing_state": "CA",
"billing_county": "San Francisco",
"billing_postal_code": "94105",
"billing_country": "US",
"shipping_address_1": "123 Main St.",
"shipping_address_2": "Suite 100",
"shipping_city": "San Francisco",
"shipping_state": "CA",
"shipping_county": "San Francisco",
"shipping_postal_code": "94105",
"shipping_country": "US",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Filter Customer with nested conditions

Returns filtered Customer data

query Parameters

$equals	varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value'
$not_equals	varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value'
$starts	varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value'
$ends	varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value'
$contains	varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value'
$in	varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second']
$is_null	varchar Match if field have null value. E.g. filter[column_name][$is_null] = true
$not_null	varchar Match if field is not null. E.g. filter[column_name][$not_null] = true
$not_in	varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second']
$lt	varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value'
$lte	varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value'
$gt	varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value'
$gte	varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value'
$sortorder	varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc\|desc'
$limit	varchar Limit results E.g. filter[$limit] = '50' \| For offset: filter[$offset] = '20'
$paginate	varchar Paginate results E.g. filter[$paginate] = '50

Responses

Response samples

Content type

application/json

{"data": [{"id": "cus_OiMmx1XPUtvVcZ",
"parent_id": null,
"consolidate_invoices": null,
"name": "abc sad",
"company": null,
"email": "[email protected]",
"phone_number": null,
"po_number": null,
"legal_entity": null,
"currency": "USD",
"billing_cycle_day": null,
"notes": null,
"image": null,
"customer_number": "CUST_000813",
"terms": null,
"created_at": "2023-09-27T10:37:00+01:00",
"updated_at": "2023-11-13T13:53:00+00:00",
"portal_is_enabled": 0,
"tax_exempt": null,
"certificate_id": null,
"certificate_type": null,
"issuing_jurisdiction": null,
"entity_use_code": null,
"description": null,
"tax_company": null,
"vat_id": null,
"last_activity": "",
"created_by": "1",
"updated_by": "1",
"assigned_to": "1",
"assigned_group_id": null,
"auto_charge": 1,
"billing_address_1": null,
"billing_address_2": null,
"billing_address_3": null,
"billing_city": null,
"billing_state": null,
"billing_county": null,
"billing_postal_code": null,
"billing_country": null,
"billing_name": null,
"billing_email": null,
"shipping_address_1": null,
"shipping_address_2": null,
"shipping_address_3": null,
"shipping_city": null,
"shipping_state": null,
"shipping_county": null,
"shipping_postal_code": null,
"shipping_country": null,
"shipping_name": null,
"shipping_email": null,
"data_source": "SubscriptionFlow Migration Tool",
"primary_churn_score_id": null,
"primary_churn_score_value": null,
"primary_churn_score_grade": null,
"miscellaneous_charges_exempt": null,
"invoice_payer": null
}
]
}

Bulk destroy Customers

Returns deleted Customers data

query Parameters

ids

required

varchar

Array of ids to be deleted.

Responses

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"parent_id": "__test__cs5VnHhSBWl7eY2bl",
"name": "Acme Corp",
"phone_number": "+1 (123) 456-7890",
"po_number": "PO12345",
"legal_entity": "Acme Corp Legal Entity",
"billing_cycle_day": "15",
"notes": "Important customer with special requirements.",
"image": "https://www.subscriptionflow.com/",
"customer_number": "12345",
"terms": "Net 30",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"deleted_at": "2020-01-01T00:00:00Z",
"portal_pass": "123456",
"portal_email": "[email protected]",
"portal_is_enabled": 1,
"last_successful_login": "2020-01-01T00:00:00Z",
"last_failed_login": "2020-01-01T00:00:00Z",
"tax_exempt": 0,
"certificate_id": "12345",
"certificate_type": "resale",
"issuing_jurisdiction": "California",
"entity_use_code": "A",
"description": "Important customer with special requirements.",
"tax_company": "__test__cs3VnHhSBWl7eY2bl",
"vat_id": "12345",
"last_activity": "2020-01-01T00:00:00Z",
"created_by": "__test__us3VnHhSBWl7eY2bl",
"updated_by": "__test__us3VnHhSBWl7eY2bl",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
"auto_charge": 0,
"balance": 0,
"unapplied_amount": 0,
"billing_address_1": "123 Main St.",
"billing_address_2": "Suite 100",
"billing_city": "San Francisco",
"billing_state": "CA",
"billing_county": "San Francisco",
"billing_postal_code": "94105",
"billing_country": "US",
"shipping_address_1": "123 Main St.",
"shipping_address_2": "Suite 100",
"shipping_city": "San Francisco",
"shipping_state": "CA",
"shipping_county": "San Francisco",
"shipping_postal_code": "94105",
"shipping_country": "US",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Get list of Email Addresses

Retrieve a list of all email addresses stored in the system. This endpoint returns an overview of each email address, including associated details.

Responses

Response Schema: application/json

email	any <varchar> (Email) email
primary	any <tinyint> (Primary) primary
invalid	any <tinyint> (Invalid) invalid
opt_out	any <tinyint> (Opt Out) opt_out

Response samples

Content type

application/json

{"email": "",
"primary": "",
"invalid": "",
"opt_out": ""
}

Store a new EmailAddress

Create and save a new email address in the system. Provide necessary details in the request body to successfully register the new email address.

Request Body schema: application/json
required

email	any <varchar> (Email) email
primary	any <tinyint> (Primary) primary
invalid	any <tinyint> (Invalid) invalid
opt_out	any <tinyint> (Opt Out) opt_out

Responses

Request samples

Payload

Content type

application/json

{"email": "",
"primary": "",
"invalid": "",
"opt_out": ""
}

Response samples

Content type

application/json

{"email": "",
"primary": "",
"invalid": "",
"opt_out": ""
}

Get EmailAddress information

Retrieve detailed information about a specific email address. This operation requires the email address ID to fetch and display the relevant data.

path Parameters

email-address

required

char

EmailAddress id

Responses

Response Schema: application/json

email	any <varchar> (Email) email
primary	any <tinyint> (Primary) primary
invalid	any <tinyint> (Invalid) invalid
opt_out	any <tinyint> (Opt Out) opt_out

Response samples

Content type

application/json

{"email": "",
"primary": "",
"invalid": "",
"opt_out": ""
}

Update existing EmailAddress

Modify the details of an existing email address. Provide the email address ID and updated information in the request body to apply changes.

path Parameters

email-address

required

char

EmailAddress id

Request Body schema: application/json
required

email	any <varchar> (Email) email
primary	any <tinyint> (Primary) primary
invalid	any <tinyint> (Invalid) invalid
opt_out	any <tinyint> (Opt Out) opt_out

Responses

Response Schema: application/json

email	any <varchar> (Email) email
primary	any <tinyint> (Primary) primary
invalid	any <tinyint> (Invalid) invalid
opt_out	any <tinyint> (Opt Out) opt_out

Request samples

Payload

Content type

application/json

{"email": "",
"primary": "",
"invalid": "",
"opt_out": ""
}

Response samples

Content type

application/json

{"email": "",
"primary": "",
"invalid": "",
"opt_out": ""
}

Delete existing EmailAddress

Permanently remove a specific email address from the system. This operation requires the email address ID to identify and delete the record.

path Parameters

email-address

required

char

EmailAddress id

Responses

Response samples

Content type

application/json

{"email": "",
"primary": "",
"invalid": "",
"opt_out": ""
}

Get with-relations list of Customers

Returns list of Customers with all foreign keys

Responses

Response Schema: application/json

email	any <varchar> (Email) email
primary	any <tinyint> (Primary) primary
invalid	any <tinyint> (Invalid) invalid
opt_out	any <tinyint> (Opt Out) opt_out

Response samples

Content type

application/json

{"email": "",
"primary": "",
"invalid": "",
"opt_out": ""
}

Get related list of Customers

Returns one-to-many list of Customers with related Module

path Parameters

id required	char EmailAddress id
related required	varchar hasMany relation name

Responses

Response Schema: application/json

email	any <varchar> (Email) email
primary	any <tinyint> (Primary) primary
invalid	any <tinyint> (Invalid) invalid
opt_out	any <tinyint> (Opt Out) opt_out

Response samples

Content type

application/json

{"email": "",
"primary": "",
"invalid": "",
"opt_out": ""
}

Get filtered list of Customers

Returns list of Customers with quick filters

path Parameters

fieldName

required

varchar

Field name to apply filter E.g. 'name' = 'John'

Responses

Response Schema: application/json

email	any <varchar> (Email) email
primary	any <tinyint> (Primary) primary
invalid	any <tinyint> (Invalid) invalid
opt_out	any <tinyint> (Opt Out) opt_out

Response samples

Content type

application/json

{"email": "",
"primary": "",
"invalid": "",
"opt_out": ""
}

Filter EmailAddress with nested conditions

Returns filtered EmailAddress data

query Parameters

$equals	varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value'
$not_equals	varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value'
$starts	varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value'
$ends	varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value'
$contains	varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value'
$in	varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second']
$is_null	varchar Match if field have null value. E.g. filter[column_name][$is_null] = true
$not_null	varchar Match if field is not null. E.g. filter[column_name][$not_null] = true
$not_in	varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second']
$lt	varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value'
$lte	varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value'
$gt	varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value'
$gte	varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value'
$sortorder	varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc\|desc'
$limit	varchar Limit results E.g. filter[$limit] = '50' \| For offset: filter[$offset] = '20'
$paginate	varchar Paginate results E.g. filter[$paginate] = '50

Responses

Response samples

Content type

application/json

{"email": "",
"primary": "",
"invalid": "",
"opt_out": ""
}

Bulk destroy Customers

Returns deleted Customers data

query Parameters

ids

required

varchar

Array of ids to be deleted.

Responses

Response samples

Content type

application/json

{"email": "",
"primary": "",
"invalid": "",
"opt_out": ""
}

Contacts

A contact is a person associated with a customer. The contact details include the contact ID, name, email, phone, and status.

Get list of Contacts

Retrieves a list of contacts added to your SubscriptionFlow instance. The list contains the necessary contact details such as Name, Balance, and the Contact ID. You can use the Contact ID to retrieve the contact details.

Responses

Response Schema: application/json

id	any <char> (Id) The unique identifier for the contact.
customer_id	any <char> (Customer) The identifier of the customer.
salutation	any <varchar> (Salutation) The salutation of the contact.
first_name	any <varchar> (First Name) The first name of the contact.
last_name	any <varchar> (Last Name) The last name of the contact.
name	any <varchar> (Name) The name of the contact.
email	any <varchar> (Email) The email address of the contact.
work_phone	any <varchar> (Work Phone) The work phone number of the contact.
personal_phone	any <varchar> (Personal Phone) The personal phone number of the contact.
home_phone	any <varchar> (Home Phone) The home phone number of the contact.
other_phone	any <varchar> (Other Phone) The other phone number of the contact.
fax	any <varchar> (Fax) The fax number of the contact.
description	any <text> (Description) The description of the contact.
is_primary	any <tinyint> (Is Primary) The primary contact of the customer.
created_at	any <timestamp> (Created At) The date and time when the contact was created.
updated_at	any <timestamp> (Updated At) The date and time when the contact was last updated.
created_by	any <char> (Created By) The user who created the contact.
updated_by	any <char> (Updated By) The user who last updated the contact.
assigned_to	any <char> (Assigned To) The user who the contact is assigned to.
assigned_group_id	any <char> (Assigned Group) The identifier of the group who the contact is assigned to.
billing_address_1	any <text> (Billing Address 1) The billing address of the contact.
billing_address_2	any <text> (Billing Address 2) The billing address of the contact.
billing_city	any <varchar> (Billing City) The billing city of the contact.
billing_state	any <varchar> (Billing State) The billing state of the contact.
billing_county	any <varchar> (Billing County) The billing county of the contact.
billing_postal_code	any <varchar> (Billing Postal Code) The billing postal code of the contact.
billing_country	any <varchar> (Billing Country) The billing country of the contact.
shipping_address_1	any <text> (Shipping Address 1) The shipping address of the contact.
shipping_address_2	any <text> (Shipping Address 2) The shipping address of the contact.
shipping_city	any <contacts> (Shipping City) The shipping city of the contact.
shipping_state	any <varchar> (Shipping State) The shipping state of the contact.
shipping_county	any <varchar> (Shipping County) The shipping county of the contact.
shipping_postal_code	any <contacts> (Shipping Postal Code) The shipping postal code of the contact.
shipping_country	any <varchar> (Shipping Country) The shipping country of the contact.
data_source	any <char> (Data Source) The data source of the contact.

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"customer_id": "__test__cs5VnHhSBWl7eY2bl",
"salutation": "Mr",
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"email": "[email protected]",
"work_phone": "+1 (123) 456-7890",
"personal_phone": "+1 (123) 456-7890",
"home_phone": "+1 (123) 456-7890",
"other_phone": "+1 (123) 456-7890",
"fax": "+1 (123) 456-7890",
"description": "Important contact with special requirements.",
"is_primary": "1",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
"billing_address_1": "",
"billing_address_2": "",
"billing_city": "",
"billing_state": "",
"billing_county": "",
"billing_postal_code": "",
"billing_country": "",
"shipping_address_1": "",
"shipping_address_2": "",
"shipping_city": "",
"shipping_state": "",
"shipping_county": "",
"shipping_postal_code": "",
"shipping_country": "",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Store a new Contact

Creates a contact. You can create a contact and then create subscriptions for the contact when required. When creating a contact, you can pass along the billing address and shipping address of the contact.

Request Body schema: application/json
required

id	any <char> (Id) The unique identifier for the contact.
customer_id	any <char> (Customer) The identifier of the customer.
salutation	any <varchar> (Salutation) The salutation of the contact.
first_name	any <varchar> (First Name) The first name of the contact.
last_name	any <varchar> (Last Name) The last name of the contact.
name	any <varchar> (Name) The name of the contact.
email	any <varchar> (Email) The email address of the contact.
work_phone	any <varchar> (Work Phone) The work phone number of the contact.
personal_phone	any <varchar> (Personal Phone) The personal phone number of the contact.
home_phone	any <varchar> (Home Phone) The home phone number of the contact.
other_phone	any <varchar> (Other Phone) The other phone number of the contact.
fax	any <varchar> (Fax) The fax number of the contact.
description	any <text> (Description) The description of the contact.
is_primary	any <tinyint> (Is Primary) The primary contact of the customer.
created_at	any <timestamp> (Created At) The date and time when the contact was created.
updated_at	any <timestamp> (Updated At) The date and time when the contact was last updated.
created_by	any <char> (Created By) The user who created the contact.
updated_by	any <char> (Updated By) The user who last updated the contact.
assigned_to	any <char> (Assigned To) The user who the contact is assigned to.
assigned_group_id	any <char> (Assigned Group) The identifier of the group who the contact is assigned to.
billing_address_1	any <text> (Billing Address 1) The billing address of the contact.
billing_address_2	any <text> (Billing Address 2) The billing address of the contact.
billing_city	any <varchar> (Billing City) The billing city of the contact.
billing_state	any <varchar> (Billing State) The billing state of the contact.
billing_county	any <varchar> (Billing County) The billing county of the contact.
billing_postal_code	any <varchar> (Billing Postal Code) The billing postal code of the contact.
billing_country	any <varchar> (Billing Country) The billing country of the contact.
shipping_address_1	any <text> (Shipping Address 1) The shipping address of the contact.
shipping_address_2	any <text> (Shipping Address 2) The shipping address of the contact.
shipping_city	any <contacts> (Shipping City) The shipping city of the contact.
shipping_state	any <varchar> (Shipping State) The shipping state of the contact.
shipping_county	any <varchar> (Shipping County) The shipping county of the contact.
shipping_postal_code	any <contacts> (Shipping Postal Code) The shipping postal code of the contact.
shipping_country	any <varchar> (Shipping Country) The shipping country of the contact.
data_source	any <char> (Data Source) The data source of the contact.

Responses

Request samples

Payload

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"customer_id": "__test__cs5VnHhSBWl7eY2bl",
"salutation": "Mr",
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"email": "[email protected]",
"work_phone": "+1 (123) 456-7890",
"personal_phone": "+1 (123) 456-7890",
"home_phone": "+1 (123) 456-7890",
"other_phone": "+1 (123) 456-7890",
"fax": "+1 (123) 456-7890",
"description": "Important contact with special requirements.",
"is_primary": "1",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
"billing_address_1": "",
"billing_address_2": "",
"billing_city": "",
"billing_state": "",
"billing_county": "",
"billing_postal_code": "",
"billing_country": "",
"shipping_address_1": "",
"shipping_address_2": "",
"shipping_city": "",
"shipping_state": "",
"shipping_county": "",
"shipping_postal_code": "",
"shipping_country": "",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"customer_id": "__test__cs5VnHhSBWl7eY2bl",
"salutation": "Mr",
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"email": "[email protected]",
"work_phone": "+1 (123) 456-7890",
"personal_phone": "+1 (123) 456-7890",
"home_phone": "+1 (123) 456-7890",
"other_phone": "+1 (123) 456-7890",
"fax": "+1 (123) 456-7890",
"description": "Important contact with special requirements.",
"is_primary": "1",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
"billing_address_1": "",
"billing_address_2": "",
"billing_city": "",
"billing_state": "",
"billing_county": "",
"billing_postal_code": "",
"billing_country": "",
"shipping_address_1": "",
"shipping_address_2": "",
"shipping_city": "",
"shipping_state": "",
"shipping_county": "",
"shipping_postal_code": "",
"shipping_country": "",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Get Contact information

Retrieves the details of an existing contact. You need to pass the unique contact ID that was returned upon successful contact creation.

path Parameters

contact

required

char

Contact id

Responses

Response Schema: application/json

id	any <char> (Id) The unique identifier for the contact.
customer_id	any <char> (Customer) The identifier of the customer.
salutation	any <varchar> (Salutation) The salutation of the contact.
first_name	any <varchar> (First Name) The first name of the contact.
last_name	any <varchar> (Last Name) The last name of the contact.
name	any <varchar> (Name) The name of the contact.
email	any <varchar> (Email) The email address of the contact.
work_phone	any <varchar> (Work Phone) The work phone number of the contact.
personal_phone	any <varchar> (Personal Phone) The personal phone number of the contact.
home_phone	any <varchar> (Home Phone) The home phone number of the contact.
other_phone	any <varchar> (Other Phone) The other phone number of the contact.
fax	any <varchar> (Fax) The fax number of the contact.
description	any <text> (Description) The description of the contact.
is_primary	any <tinyint> (Is Primary) The primary contact of the customer.
created_at	any <timestamp> (Created At) The date and time when the contact was created.
updated_at	any <timestamp> (Updated At) The date and time when the contact was last updated.
created_by	any <char> (Created By) The user who created the contact.
updated_by	any <char> (Updated By) The user who last updated the contact.
assigned_to	any <char> (Assigned To) The user who the contact is assigned to.
assigned_group_id	any <char> (Assigned Group) The identifier of the group who the contact is assigned to.
billing_address_1	any <text> (Billing Address 1) The billing address of the contact.
billing_address_2	any <text> (Billing Address 2) The billing address of the contact.
billing_city	any <varchar> (Billing City) The billing city of the contact.
billing_state	any <varchar> (Billing State) The billing state of the contact.
billing_county	any <varchar> (Billing County) The billing county of the contact.
billing_postal_code	any <varchar> (Billing Postal Code) The billing postal code of the contact.
billing_country	any <varchar> (Billing Country) The billing country of the contact.
shipping_address_1	any <text> (Shipping Address 1) The shipping address of the contact.
shipping_address_2	any <text> (Shipping Address 2) The shipping address of the contact.
shipping_city	any <contacts> (Shipping City) The shipping city of the contact.
shipping_state	any <varchar> (Shipping State) The shipping state of the contact.
shipping_county	any <varchar> (Shipping County) The shipping county of the contact.
shipping_postal_code	any <contacts> (Shipping Postal Code) The shipping postal code of the contact.
shipping_country	any <varchar> (Shipping Country) The shipping country of the contact.
data_source	any <char> (Data Source) The data source of the contact.

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"customer_id": "__test__cs5VnHhSBWl7eY2bl",
"salutation": "Mr",
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"email": "[email protected]",
"work_phone": "+1 (123) 456-7890",
"personal_phone": "+1 (123) 456-7890",
"home_phone": "+1 (123) 456-7890",
"other_phone": "+1 (123) 456-7890",
"fax": "+1 (123) 456-7890",
"description": "Important contact with special requirements.",
"is_primary": "1",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
"billing_address_1": "",
"billing_address_2": "",
"billing_city": "",
"billing_state": "",
"billing_county": "",
"billing_postal_code": "",
"billing_country": "",
"shipping_address_1": "",
"shipping_address_2": "",
"shipping_city": "",
"shipping_state": "",
"shipping_county": "",
"shipping_postal_code": "",
"shipping_country": "",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Update existing Contact

Updates the specified contact by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the contact's billing address but not the shipping address, the contact's shipping address will be unaltered.

path Parameters

contact

required

char

Contact id

Request Body schema: application/json
required

id	any <char> (Id) The unique identifier for the contact.
customer_id	any <char> (Customer) The identifier of the customer.
salutation	any <varchar> (Salutation) The salutation of the contact.
first_name	any <varchar> (First Name) The first name of the contact.
last_name	any <varchar> (Last Name) The last name of the contact.
name	any <varchar> (Name) The name of the contact.
email	any <varchar> (Email) The email address of the contact.
work_phone	any <varchar> (Work Phone) The work phone number of the contact.
personal_phone	any <varchar> (Personal Phone) The personal phone number of the contact.
home_phone	any <varchar> (Home Phone) The home phone number of the contact.
other_phone	any <varchar> (Other Phone) The other phone number of the contact.
fax	any <varchar> (Fax) The fax number of the contact.
description	any <text> (Description) The description of the contact.
is_primary	any <tinyint> (Is Primary) The primary contact of the customer.
created_at	any <timestamp> (Created At) The date and time when the contact was created.
updated_at	any <timestamp> (Updated At) The date and time when the contact was last updated.
created_by	any <char> (Created By) The user who created the contact.
updated_by	any <char> (Updated By) The user who last updated the contact.
assigned_to	any <char> (Assigned To) The user who the contact is assigned to.
assigned_group_id	any <char> (Assigned Group) The identifier of the group who the contact is assigned to.
billing_address_1	any <text> (Billing Address 1) The billing address of the contact.
billing_address_2	any <text> (Billing Address 2) The billing address of the contact.
billing_city	any <varchar> (Billing City) The billing city of the contact.
billing_state	any <varchar> (Billing State) The billing state of the contact.
billing_county	any <varchar> (Billing County) The billing county of the contact.
billing_postal_code	any <varchar> (Billing Postal Code) The billing postal code of the contact.
billing_country	any <varchar> (Billing Country) The billing country of the contact.
shipping_address_1	any <text> (Shipping Address 1) The shipping address of the contact.
shipping_address_2	any <text> (Shipping Address 2) The shipping address of the contact.
shipping_city	any <contacts> (Shipping City) The shipping city of the contact.
shipping_state	any <varchar> (Shipping State) The shipping state of the contact.
shipping_county	any <varchar> (Shipping County) The shipping county of the contact.
shipping_postal_code	any <contacts> (Shipping Postal Code) The shipping postal code of the contact.
shipping_country	any <varchar> (Shipping Country) The shipping country of the contact.
data_source	any <char> (Data Source) The data source of the contact.

Responses

Response Schema: application/json

id	any <char> (Id) The unique identifier for the contact.
customer_id	any <char> (Customer) The identifier of the customer.
salutation	any <varchar> (Salutation) The salutation of the contact.
first_name	any <varchar> (First Name) The first name of the contact.
last_name	any <varchar> (Last Name) The last name of the contact.
name	any <varchar> (Name) The name of the contact.
email	any <varchar> (Email) The email address of the contact.
work_phone	any <varchar> (Work Phone) The work phone number of the contact.
personal_phone	any <varchar> (Personal Phone) The personal phone number of the contact.
home_phone	any <varchar> (Home Phone) The home phone number of the contact.
other_phone	any <varchar> (Other Phone) The other phone number of the contact.
fax	any <varchar> (Fax) The fax number of the contact.
description	any <text> (Description) The description of the contact.
is_primary	any <tinyint> (Is Primary) The primary contact of the customer.
created_at	any <timestamp> (Created At) The date and time when the contact was created.
updated_at	any <timestamp> (Updated At) The date and time when the contact was last updated.
created_by	any <char> (Created By) The user who created the contact.
updated_by	any <char> (Updated By) The user who last updated the contact.
assigned_to	any <char> (Assigned To) The user who the contact is assigned to.
assigned_group_id	any <char> (Assigned Group) The identifier of the group who the contact is assigned to.
billing_address_1	any <text> (Billing Address 1) The billing address of the contact.
billing_address_2	any <text> (Billing Address 2) The billing address of the contact.
billing_city	any <varchar> (Billing City) The billing city of the contact.
billing_state	any <varchar> (Billing State) The billing state of the contact.
billing_county	any <varchar> (Billing County) The billing county of the contact.
billing_postal_code	any <varchar> (Billing Postal Code) The billing postal code of the contact.
billing_country	any <varchar> (Billing Country) The billing country of the contact.
shipping_address_1	any <text> (Shipping Address 1) The shipping address of the contact.
shipping_address_2	any <text> (Shipping Address 2) The shipping address of the contact.
shipping_city	any <contacts> (Shipping City) The shipping city of the contact.
shipping_state	any <varchar> (Shipping State) The shipping state of the contact.
shipping_county	any <varchar> (Shipping County) The shipping county of the contact.
shipping_postal_code	any <contacts> (Shipping Postal Code) The shipping postal code of the contact.
shipping_country	any <varchar> (Shipping Country) The shipping country of the contact.
data_source	any <char> (Data Source) The data source of the contact.

Request samples

Payload

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"customer_id": "__test__cs5VnHhSBWl7eY2bl",
"salutation": "Mr",
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"email": "[email protected]",
"work_phone": "+1 (123) 456-7890",
"personal_phone": "+1 (123) 456-7890",
"home_phone": "+1 (123) 456-7890",
"other_phone": "+1 (123) 456-7890",
"fax": "+1 (123) 456-7890",
"description": "Important contact with special requirements.",
"is_primary": "1",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
"billing_address_1": "",
"billing_address_2": "",
"billing_city": "",
"billing_state": "",
"billing_county": "",
"billing_postal_code": "",
"billing_country": "",
"shipping_address_1": "",
"shipping_address_2": "",
"shipping_city": "",
"shipping_state": "",
"shipping_county": "",
"shipping_postal_code": "",
"shipping_country": "",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"customer_id": "__test__cs5VnHhSBWl7eY2bl",
"salutation": "Mr",
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"email": "[email protected]",
"work_phone": "+1 (123) 456-7890",
"personal_phone": "+1 (123) 456-7890",
"home_phone": "+1 (123) 456-7890",
"other_phone": "+1 (123) 456-7890",
"fax": "+1 (123) 456-7890",
"description": "Important contact with special requirements.",
"is_primary": "1",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
"billing_address_1": "",
"billing_address_2": "",
"billing_city": "",
"billing_state": "",
"billing_county": "",
"billing_postal_code": "",
"billing_country": "",
"shipping_address_1": "",
"shipping_address_2": "",
"shipping_city": "",
"shipping_state": "",
"shipping_county": "",
"shipping_postal_code": "",
"shipping_country": "",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Delete existing Contact

Deletes a record and returns deleted record

path Parameters

contact

required

char

Contact id

Responses

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"customer_id": "__test__cs5VnHhSBWl7eY2bl",
"salutation": "Mr",
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"email": "[email protected]",
"work_phone": "+1 (123) 456-7890",
"personal_phone": "+1 (123) 456-7890",
"home_phone": "+1 (123) 456-7890",
"other_phone": "+1 (123) 456-7890",
"fax": "+1 (123) 456-7890",
"description": "Important contact with special requirements.",
"is_primary": "1",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
"billing_address_1": "",
"billing_address_2": "",
"billing_city": "",
"billing_state": "",
"billing_county": "",
"billing_postal_code": "",
"billing_country": "",
"shipping_address_1": "",
"shipping_address_2": "",
"shipping_city": "",
"shipping_state": "",
"shipping_county": "",
"shipping_postal_code": "",
"shipping_country": "",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Get with-relations list of Contacts

Returns list of Contacts with all foreign keys

Responses

Response Schema: application/json

id	any <char> (Id) The unique identifier for the contact.
customer_id	any <char> (Customer) The identifier of the customer.
salutation	any <varchar> (Salutation) The salutation of the contact.
first_name	any <varchar> (First Name) The first name of the contact.
last_name	any <varchar> (Last Name) The last name of the contact.
name	any <varchar> (Name) The name of the contact.
email	any <varchar> (Email) The email address of the contact.
work_phone	any <varchar> (Work Phone) The work phone number of the contact.
personal_phone	any <varchar> (Personal Phone) The personal phone number of the contact.
home_phone	any <varchar> (Home Phone) The home phone number of the contact.
other_phone	any <varchar> (Other Phone) The other phone number of the contact.
fax	any <varchar> (Fax) The fax number of the contact.
description	any <text> (Description) The description of the contact.
is_primary	any <tinyint> (Is Primary) The primary contact of the customer.
created_at	any <timestamp> (Created At) The date and time when the contact was created.
updated_at	any <timestamp> (Updated At) The date and time when the contact was last updated.
created_by	any <char> (Created By) The user who created the contact.
updated_by	any <char> (Updated By) The user who last updated the contact.
assigned_to	any <char> (Assigned To) The user who the contact is assigned to.
assigned_group_id	any <char> (Assigned Group) The identifier of the group who the contact is assigned to.
billing_address_1	any <text> (Billing Address 1) The billing address of the contact.
billing_address_2	any <text> (Billing Address 2) The billing address of the contact.
billing_city	any <varchar> (Billing City) The billing city of the contact.
billing_state	any <varchar> (Billing State) The billing state of the contact.
billing_county	any <varchar> (Billing County) The billing county of the contact.
billing_postal_code	any <varchar> (Billing Postal Code) The billing postal code of the contact.
billing_country	any <varchar> (Billing Country) The billing country of the contact.
shipping_address_1	any <text> (Shipping Address 1) The shipping address of the contact.
shipping_address_2	any <text> (Shipping Address 2) The shipping address of the contact.
shipping_city	any <contacts> (Shipping City) The shipping city of the contact.
shipping_state	any <varchar> (Shipping State) The shipping state of the contact.
shipping_county	any <varchar> (Shipping County) The shipping county of the contact.
shipping_postal_code	any <contacts> (Shipping Postal Code) The shipping postal code of the contact.
shipping_country	any <varchar> (Shipping Country) The shipping country of the contact.
data_source	any <char> (Data Source) The data source of the contact.

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"customer_id": "__test__cs5VnHhSBWl7eY2bl",
"salutation": "Mr",
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"email": "[email protected]",
"work_phone": "+1 (123) 456-7890",
"personal_phone": "+1 (123) 456-7890",
"home_phone": "+1 (123) 456-7890",
"other_phone": "+1 (123) 456-7890",
"fax": "+1 (123) 456-7890",
"description": "Important contact with special requirements.",
"is_primary": "1",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
"billing_address_1": "",
"billing_address_2": "",
"billing_city": "",
"billing_state": "",
"billing_county": "",
"billing_postal_code": "",
"billing_country": "",
"shipping_address_1": "",
"shipping_address_2": "",
"shipping_city": "",
"shipping_state": "",
"shipping_county": "",
"shipping_postal_code": "",
"shipping_country": "",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Get related list of Contacts

Returns one-to-many list of Contacts with related Module

path Parameters

id required	char Contact id
related required	varchar hasMany relation name

Responses

Response Schema: application/json

id	any <char> (Id) The unique identifier for the contact.
customer_id	any <char> (Customer) The identifier of the customer.
salutation	any <varchar> (Salutation) The salutation of the contact.
first_name	any <varchar> (First Name) The first name of the contact.
last_name	any <varchar> (Last Name) The last name of the contact.
name	any <varchar> (Name) The name of the contact.
email	any <varchar> (Email) The email address of the contact.
work_phone	any <varchar> (Work Phone) The work phone number of the contact.
personal_phone	any <varchar> (Personal Phone) The personal phone number of the contact.
home_phone	any <varchar> (Home Phone) The home phone number of the contact.
other_phone	any <varchar> (Other Phone) The other phone number of the contact.
fax	any <varchar> (Fax) The fax number of the contact.
description	any <text> (Description) The description of the contact.
is_primary	any <tinyint> (Is Primary) The primary contact of the customer.
created_at	any <timestamp> (Created At) The date and time when the contact was created.
updated_at	any <timestamp> (Updated At) The date and time when the contact was last updated.
created_by	any <char> (Created By) The user who created the contact.
updated_by	any <char> (Updated By) The user who last updated the contact.
assigned_to	any <char> (Assigned To) The user who the contact is assigned to.
assigned_group_id	any <char> (Assigned Group) The identifier of the group who the contact is assigned to.
billing_address_1	any <text> (Billing Address 1) The billing address of the contact.
billing_address_2	any <text> (Billing Address 2) The billing address of the contact.
billing_city	any <varchar> (Billing City) The billing city of the contact.
billing_state	any <varchar> (Billing State) The billing state of the contact.
billing_county	any <varchar> (Billing County) The billing county of the contact.
billing_postal_code	any <varchar> (Billing Postal Code) The billing postal code of the contact.
billing_country	any <varchar> (Billing Country) The billing country of the contact.
shipping_address_1	any <text> (Shipping Address 1) The shipping address of the contact.
shipping_address_2	any <text> (Shipping Address 2) The shipping address of the contact.
shipping_city	any <contacts> (Shipping City) The shipping city of the contact.
shipping_state	any <varchar> (Shipping State) The shipping state of the contact.
shipping_county	any <varchar> (Shipping County) The shipping county of the contact.
shipping_postal_code	any <contacts> (Shipping Postal Code) The shipping postal code of the contact.
shipping_country	any <varchar> (Shipping Country) The shipping country of the contact.
data_source	any <char> (Data Source) The data source of the contact.

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"customer_id": "__test__cs5VnHhSBWl7eY2bl",
"salutation": "Mr",
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"email": "[email protected]",
"work_phone": "+1 (123) 456-7890",
"personal_phone": "+1 (123) 456-7890",
"home_phone": "+1 (123) 456-7890",
"other_phone": "+1 (123) 456-7890",
"fax": "+1 (123) 456-7890",
"description": "Important contact with special requirements.",
"is_primary": "1",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
"billing_address_1": "",
"billing_address_2": "",
"billing_city": "",
"billing_state": "",
"billing_county": "",
"billing_postal_code": "",
"billing_country": "",
"shipping_address_1": "",
"shipping_address_2": "",
"shipping_city": "",
"shipping_state": "",
"shipping_county": "",
"shipping_postal_code": "",
"shipping_country": "",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Get filtered list of Contacts

Returns list of Contacts with quick filters

path Parameters

fieldName

required

varchar

Field name to apply filter E.g. 'name' = 'John'

Responses

Response Schema: application/json

id	any <char> (Id) The unique identifier for the contact.
customer_id	any <char> (Customer) The identifier of the customer.
salutation	any <varchar> (Salutation) The salutation of the contact.
first_name	any <varchar> (First Name) The first name of the contact.
last_name	any <varchar> (Last Name) The last name of the contact.
name	any <varchar> (Name) The name of the contact.
email	any <varchar> (Email) The email address of the contact.
work_phone	any <varchar> (Work Phone) The work phone number of the contact.
personal_phone	any <varchar> (Personal Phone) The personal phone number of the contact.
home_phone	any <varchar> (Home Phone) The home phone number of the contact.
other_phone	any <varchar> (Other Phone) The other phone number of the contact.
fax	any <varchar> (Fax) The fax number of the contact.
description	any <text> (Description) The description of the contact.
is_primary	any <tinyint> (Is Primary) The primary contact of the customer.
created_at	any <timestamp> (Created At) The date and time when the contact was created.
updated_at	any <timestamp> (Updated At) The date and time when the contact was last updated.
created_by	any <char> (Created By) The user who created the contact.
updated_by	any <char> (Updated By) The user who last updated the contact.
assigned_to	any <char> (Assigned To) The user who the contact is assigned to.
assigned_group_id	any <char> (Assigned Group) The identifier of the group who the contact is assigned to.
billing_address_1	any <text> (Billing Address 1) The billing address of the contact.
billing_address_2	any <text> (Billing Address 2) The billing address of the contact.
billing_city	any <varchar> (Billing City) The billing city of the contact.
billing_state	any <varchar> (Billing State) The billing state of the contact.
billing_county	any <varchar> (Billing County) The billing county of the contact.
billing_postal_code	any <varchar> (Billing Postal Code) The billing postal code of the contact.
billing_country	any <varchar> (Billing Country) The billing country of the contact.
shipping_address_1	any <text> (Shipping Address 1) The shipping address of the contact.
shipping_address_2	any <text> (Shipping Address 2) The shipping address of the contact.
shipping_city	any <contacts> (Shipping City) The shipping city of the contact.
shipping_state	any <varchar> (Shipping State) The shipping state of the contact.
shipping_county	any <varchar> (Shipping County) The shipping county of the contact.
shipping_postal_code	any <contacts> (Shipping Postal Code) The shipping postal code of the contact.
shipping_country	any <varchar> (Shipping Country) The shipping country of the contact.
data_source	any <char> (Data Source) The data source of the contact.

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"customer_id": "__test__cs5VnHhSBWl7eY2bl",
"salutation": "Mr",
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"email": "[email protected]",
"work_phone": "+1 (123) 456-7890",
"personal_phone": "+1 (123) 456-7890",
"home_phone": "+1 (123) 456-7890",
"other_phone": "+1 (123) 456-7890",
"fax": "+1 (123) 456-7890",
"description": "Important contact with special requirements.",
"is_primary": "1",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
"billing_address_1": "",
"billing_address_2": "",
"billing_city": "",
"billing_state": "",
"billing_county": "",
"billing_postal_code": "",
"billing_country": "",
"shipping_address_1": "",
"shipping_address_2": "",
"shipping_city": "",
"shipping_state": "",
"shipping_county": "",
"shipping_postal_code": "",
"shipping_country": "",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Filter Contact with nested conditions

Returns filtered Contact data

query Parameters

$equals	varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value'
$not_equals	varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value'
$starts	varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value'
$ends	varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value'
$contains	varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value'
$in	varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second']
$is_null	varchar Match if field have null value. E.g. filter[column_name][$is_null] = true
$not_null	varchar Match if field is not null. E.g. filter[column_name][$not_null] = true
$not_in	varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second']
$lt	varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value'
$lte	varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value'
$gt	varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value'
$gte	varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value'
$sortorder	varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc\|desc'
$limit	varchar Limit results E.g. filter[$limit] = '50' \| For offset: filter[$offset] = '20'
$paginate	varchar Paginate results E.g. filter[$paginate] = '50

Responses

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"customer_id": "__test__cs5VnHhSBWl7eY2bl",
"salutation": "Mr",
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"email": "[email protected]",
"work_phone": "+1 (123) 456-7890",
"personal_phone": "+1 (123) 456-7890",
"home_phone": "+1 (123) 456-7890",
"other_phone": "+1 (123) 456-7890",
"fax": "+1 (123) 456-7890",
"description": "Important contact with special requirements.",
"is_primary": "1",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
"billing_address_1": "",
"billing_address_2": "",
"billing_city": "",
"billing_state": "",
"billing_county": "",
"billing_postal_code": "",
"billing_country": "",
"shipping_address_1": "",
"shipping_address_2": "",
"shipping_city": "",
"shipping_state": "",
"shipping_county": "",
"shipping_postal_code": "",
"shipping_country": "",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Bulk destroy Contacts

Returns deleted Contacts data

query Parameters

ids

required

varchar

Array of ids to be deleted.

Responses

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"customer_id": "__test__cs5VnHhSBWl7eY2bl",
"salutation": "Mr",
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"email": "[email protected]",
"work_phone": "+1 (123) 456-7890",
"personal_phone": "+1 (123) 456-7890",
"home_phone": "+1 (123) 456-7890",
"other_phone": "+1 (123) 456-7890",
"fax": "+1 (123) 456-7890",
"description": "Important contact with special requirements.",
"is_primary": "1",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
"billing_address_1": "",
"billing_address_2": "",
"billing_city": "",
"billing_state": "",
"billing_county": "",
"billing_postal_code": "",
"billing_country": "",
"shipping_address_1": "",
"shipping_address_2": "",
"shipping_city": "",
"shipping_state": "",
"shipping_county": "",
"shipping_postal_code": "",
"shipping_country": "",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Subscriptions

A SubscriptionFlow subscription connects a customer record to products/services. It describes what the customer has signed up for and how often they're charged for it. The essential components of a subscription are:

Any product selected
Any plan-item for a product
Any coupons applied

Get list of Subscriptions

Retrieve a comprehensive list of all active subscriptions. This endpoint returns detailed information about each subscription.

Responses

Response Schema: application/json

	Array of objects
	object
	object

Response samples

Content type

application/json

{"data": [{"id": "8655a896-ebd3-4eb5-8ede-841c2b8c23f0",
"name": "subscription_4",
"display_name": "Creators Signup -> Creators Signup Plan",
"type": "Evergreen",
"termed_start_date": null,
"termed_initial_period": null,
"termed_initial_period_type": null,
"renewal_type": null,
"renewal_period_type": null,
"is_auto_renew": 0,
"trigger_dates": "2023-09-26",
"invoice_separate": "No",
"total_amount": 0,
"status": "Active",
"payment_status": "Pending",
"created_at": "2024-04-08T07:45:00+02:00",
"renewal_period": null,
"suspended_at": null,
"resume_suspended_at": null,
"renewed_at": null,
"cancelled_at": null,
"billing_end_date": null,
"next_bill_date": null,
"updated_at": "2024-04-19T12:59:00+02:00",
"data_source": "SubscriptionFlow(HPP)",
"trial_period": null,
"trial_period_unit": null,
"is_gift": 0,
"mv_indicator": null,
"mv_taken_out_of_delivery_system": null,
"mv_reason_taking_out_of_delivery_system": null,
"mv_early_renewal": 0,
"mv_new_term_start_date": "2023-09-26",
"mv_expiration_date": null,
"mv_remaining_term": null,
"mv_payment_recieved_date": null
}
],
"links": {"first": "https://mobilesdk.subscriptionflow.com/api/v1/subscriptions?page=1",
"last": "https://mobilesdk.subscriptionflow.com/api/v1/subscriptions?page=1",
"prev": null,
"next": null
},
"meta": {"current_page": 1,
"from": 1,
"last_page": 1,
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
}
],
"path": "https://mobilesdk.subscriptionflow.com/api/v1/subscriptions",
"per_page": 200,
"to": 3,
"total": 3
}
}

Create a new Subscription

Create and store a new subscription in the database for an existing customer in SubscriptionFlow. Provide necessary subscription details in the request body.

Request Body schema: application/json

This is a sample request body for you to understand what else can be sent in the request body.

id	any <varchar> (Id) A unique and immutable identifier for the subscription.
customer_id	any <char> (Customer) Identifier of the customer with whom this subscription is associated.
items	any <array> (Items) Identifier of the plan and product with whom this subscription is associated.
name	any <varchar> (Name) The name associated with this subscription.
type	any <varchar> (Type) The type or category of the subscription. Possible values are Termed Evergreen
termed_start_date	any <date> (Term Start Date) The date when the subscription's term starts.
termed_initial_period	any <int> (Term Initial Period) The initial period of the subscription term.
termed_initial_period_type	any <varchar> (Term Initial Period Type) The type or unit of the initial period. Possible values are month week year day
renewal_type	any <varchar> (Renewal Type) The type of renewal for the subscription.
renewal_period	any <int> (Renewal Period) The renewal period duration.
renewal_period_type	any <varchar> (Renewal Period Type) The type or unit of the renewal period. Possible values are month week year day
is_auto_renew	any <tinyint> (Is Auto Renew) Indicates whether the subscription auto-renews (1 for yes, 0 for no).
trigger_dates	any <date> (Trigger Dates) Dates or events that trigger actions related to the subscription.
invoice_separate	any <date> (Invoice the Subscription Separately) Indicates if the subscription is separately invoiced (1 for yes, 0 for no).
total_amount	any <double> (Total Amount) The total amount associated with the subscription's plan-items. Note: The total_amount value would be `0` (zero) if subscription "type" is `evergreen`
status	any <varchar> (Status) The current state of the subscription (e.g., active, suspended). Possible values are active The subscription is active and in service. pending The subscription is pending activation. draft The subscription is in draft mode. trial The subscription is in trial mode. suspended The subscription is suspended. The subscription will not renew while in this state. cancelled The subscription has been canceled and is no longer in service. expired The subscription has expired and is no longer in service.
payment_status	any <varchar> (Payment Status) The payment status of the subscription (e.g., pending, paid).
created_at	any <timestamp> (Created At) The date and time when the subscription was created.
suspended_at	any <timestamp> (Suspended At) The date and time when the subscription was suspended.
cancelled_at	any <timestamp> (Cancelled At) The date and time when the subscription was cancelled.
billing_end_date	any <date> (Billing End Date) The date when billing for the subscription ends.
updated_at	any <timestamp> (Updated At) The date and time when the subscription was last updated.
created_by	any <char> (Created By) The identifier of the user who created the subscription.
updated_by	any <char> (Updated By) The identifier of the user who last updated the subscription.
assigned_to	any <char> (Assigned To) The identifier of the user to whom the subscription is assigned.
assigned_group_id	any <char> (Assigned Group) The identifier of the group to which the subscription is assigned.
data_source	any <char> (Data Source) The source of data for the subscription.
trial_period	any <int> (Trial Period) The duration of the trial period.
trial_period_unit	any <varchar> (Trial Period Unit) The unit of the trial period duration. Possible values are days months
is_gift	any <tinyint> (Gift Subscription) Indicates if the subscription is a gift (1 for yes, 0 for no).
recipient_id	any <char> (Gift Recipient) The identifier of the recipient of the gift subscription.

Responses

Request samples

Payload

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"customer_id": "__test__sf5sukSOXdulGOV",
"items": [{"plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
"product_id": "test-0596-4722-bf72-4b90008c31a5"
}
],
"name": "Premium Subscription",
"type": "evergreen",
"termed_start_date": "2023-11-01",
"termed_initial_period": 30,
"termed_initial_period_type": "days",
"renewal_type": "monthly",
"renewal_period": 30,
"renewal_period_type": "day",
"is_auto_renew": 1,
"trigger_dates": "2023-12-01",
"invoice_separate": 0,
"total_amount": 99.99,
"status": "active",
"payment_status": "paid",
"created_at": "2023-10-15T14:30:00Z",
"suspended_at": "2023-11-05T10:45:00Z",
"cancelled_at": "2023-11-20T16:15:00Z",
"billing_end_date": "2023-12-01",
"updated_at": "2023-11-25T08:20:00Z",
"created_by": "user123",
"updated_by": "admin456",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System",
"trial_period": 15,
"trial_period_unit": "days",
"is_gift": 0,
"recipient_id": "recipient123"
}

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"customer_id": "__test__sf5sukSOXdulGOV",
"items": [{"plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
"product_id": "test-0596-4722-bf72-4b90008c31a5"
}
],
"name": "Premium Subscription",
"type": "evergreen",
"termed_start_date": "2023-11-01",
"termed_initial_period": 30,
"termed_initial_period_type": "days",
"renewal_type": "monthly",
"renewal_period": 30,
"renewal_period_type": "day",
"is_auto_renew": 1,
"trigger_dates": "2023-12-01",
"invoice_separate": 0,
"total_amount": 99.99,
"status": "active",
"payment_status": "paid",
"created_at": "2023-10-15T14:30:00Z",
"suspended_at": "2023-11-05T10:45:00Z",
"cancelled_at": "2023-11-20T16:15:00Z",
"billing_end_date": "2023-12-01",
"updated_at": "2023-11-25T08:20:00Z",
"created_by": "user123",
"updated_by": "admin456",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System",
"trial_period": 15,
"trial_period_unit": "days",
"is_gift": 0,
"recipient_id": "recipient123"
}

Get Subscription information

Retrieve detailed information about a specific subscription. This endpoint requires the subscription ID to fetch the relevant data.

path Parameters

subscription_id

required

string

The unique identifier of subscription

Responses

Response Schema: application/json

	object
	object
	object

Response samples

Content type

application/json

{"data": {"type": "subscriptions",
"id": "8655a896-ebd3-4eb5-8ede-841c2b8c23f0",
"attributes": {"id": "8655a896-ebd3-4eb5-8ede-841c2b8c23f0",
"name": "subscription_4",
"display_name": "Creators Signup -> Creators Signup Plan",
"type": "Evergreen",
"termed_start_date": null,
"termed_initial_period": null,
"termed_initial_period_type": null,
"renewal_type": null,
"renewal_period_type": null,
"is_auto_renew": 0,
"trigger_dates": "2023-09-26",
"invoice_separate": "No",
"total_amount": 0,
"status": "Active",
"payment_status": "Pending",
"created_at": "2024-04-08T07:45:00+02:00",
"renewal_period": null,
"suspended_at": null,
"resume_suspended_at": null,
"renewed_at": null,
"cancelled_at": null,
"billing_end_date": null,
"next_bill_date": null,
"updated_at": "2024-04-19T12:59:00+02:00",
"data_source": "SubscriptionFlow(HPP)",
"trial_period": null,
"trial_period_unit": null,
"is_gift": 0,
"mv_indicator": null,
"mv_taken_out_of_delivery_system": null,
"mv_reason_taking_out_of_delivery_system": null,
"mv_early_renewal": 0,
"mv_new_term_start_date": "2023-09-26",
"mv_expiration_date": null,
"mv_remaining_term": null,
"mv_payment_recieved_date": null,
"customer": {"id": "User-12345",
"name": "SF DEVELOPERS",
"email": "[email protected]",
"company": null,
"phone_number": null,
"po_number": null,
"legal_entity": null,
"currency": "USD",
"billing_cycle_day": null,
"notes": null,
"image": null,
"customer_number": "CUST_2",
"terms": null,
"created_at": "2024-02-06T09:01:00+01:00",
"updated_at": "2024-06-07T15:35:00+02:00",
"portal_is_enabled": 1,
"tax_exempt": 0,
"certificate_id": null,
"certificate_type": null,
"issuing_jurisdiction": null,
"entity_use_code": null,
"description": null,
"vat_id": null,
"last_activity": "{{LBL_GENERATED_ORDER}} <a href=\"https://mobilesdk.subscriptionflow.com/en/order-detail/d2e98cbc-92d9-474b-a2fc-3c19d164d753\">O-20</a>",
"auto_charge": 1,
"billing_address_1": "",
"billing_address_2": "",
"billing_address_3": null,
"billing_city": "",
"billing_state": "",
"billing_county": null,
"billing_postal_code": "",
"billing_country": "",
"billing_name": "",
"billing_email": "",
"shipping_address_1": "",
"shipping_address_2": "",
"shipping_address_3": null,
"shipping_city": "",
"shipping_state": "",
"shipping_county": null,
"shipping_postal_code": "",
"shipping_country": "",
"shipping_name": "",
"shipping_email": "",
"data_source": "SubscriptionFlow",
"primary_churn_score_value": null,
"primary_churn_score_grade": null,
"miscellaneous_charges_exempt": null,
"invoice_payer": null,
"consolidate_invoices": null
},
"items": [{"id": "33d0f3c9-a878-4de3-93e8-3f2901bd6717",
"plan_id": "c6849c2e-4050-4b1b-a22c-9ea8a7e45a72",
"product_id": "edf1ff75-0eb4-4c64-9c5d-c7315a378afd",
"coupon_id": null,
"plan_name": "Normal Plan",
"plan_description": "This is a normal plan",
"product_name": "MonthlySubscription",
"product_description": null,
"charges": [{"id": "c15d0bcc-524c-4e6f-8c62-a8159c725247",
"plan_price_id": "1c0346d0-dcc1-4538-b423-4522138e55d3",
"category": "onetime",
"charge_model": "flat_fee",
"list_price": 10,
"list_price_base": null,
"uom": null,
"included_units": null,
"default_quantity": "1",
"taxable": null,
"tax_mode": null,
"tax_id": null,
"bill_date": null,
"billing_period_id": null,
"name": "Normal Plan",
"plan_price": {"id": "1c0346d0-dcc1-4538-b423-4522138e55d3",
"plan_id": "c6849c2e-4050-4b1b-a22c-9ea8a7e45a72",
"product_id": "edf1ff75-0eb4-4c64-9c5d-c7315a378afd",
"name": "Normal Plan",
"description": null,
"category": "onetime",
"charge_model": "flat_fee",
"list_price": {"USD": "10"
},
"list_price_base": null,
"uom": null,
"included_units": null,
"default_quantity": null,
"trigger_condition": null,
"end_date": null,
"billing_timming": 0,
"billing_period_alignment": null,
"usage_records_rating_option": null,
"created_at": "02/06/2024 13:11",
"updated_at": "02/06/2024 13:11",
"created_by": null,
"updated_by": null,
"taxable": null,
"tax_mode": null,
"tax_id": null,
"assigned_to": null,
"billing_period_id": null,
"billing_period_months_weeks": null,
"billing_month_id": null,
"billing_day_type_id": null,
"billing_week_day_id": null,
"deleted_at": null,
"accounting_account_code": null,
"data_source": "SubscriptionFlow",
"billing_year_month_id": null,
"cost_price": null,
"additional_field": null,
"second_additional_field": null
}
}
]
}
]
}
},
"relationships": {"customer_id": {"id": "User-12345",
"link": "https://mobilesdk.subscriptionflow.com/api/v1/customers/User-12345",
"created_by": {"id": "bed76993-640d-453a-ac4d-67c4a106ec48",
"link": "https://mobilesdk.subscriptionflow.com/api/v1/users/bed76993-640d-453a-ac4d-67c4a106ec48"
},
"updated_by": {"id": "bed76993-640d-453a-ac4d-67c4a106ec48",
"link": "https://mobilesdk.subscriptionflow.com/api/v1/users/bed76993-640d-453a-ac4d-67c4a106ec48"
},
"assigned_to": {"id": "bed76993-640d-453a-ac4d-67c4a106ec48",
"link": "https://mobilesdk.subscriptionflow.com/api/v1/users/bed76993-640d-453a-ac4d-67c4a106ec48"
},
"assigned_group_id": null,
"recipient_id": null,
"tax_id": null
}
},
"links": {"self": "https://mobilesdk.subscriptionflow.com/api/v1/subscriptions/8655a896-ebd3-4eb5-8ede-841c2b8c23f0",
"app_url": "https://mobilesdk.subscriptionflow.com/subscription-detail/8655a896-ebd3-4eb5-8ede-841c2b8c23f0"
}
}

Update existing Subscription

Modify the details of an existing subscription. Provide the subscription ID and updated information in the request body.

path Parameters

subscription_id

required

string

The unique identifier of subscription

Request Body schema: application/json
required

id	any <varchar> (Id) A unique and immutable identifier for the subscription.
customer_id	any <char> (Customer) Identifier of the customer with whom this subscription is associated.
items	any <array> (Items) Identifier of the plan and product with whom this subscription is associated.
name	any <varchar> (Name) The name associated with this subscription.
type	any <varchar> (Type) The type or category of the subscription. Possible values are Termed Evergreen
termed_start_date	any <date> (Term Start Date) The date when the subscription's term starts.
termed_initial_period	any <int> (Term Initial Period) The initial period of the subscription term.
termed_initial_period_type	any <varchar> (Term Initial Period Type) The type or unit of the initial period. Possible values are month week year day
renewal_type	any <varchar> (Renewal Type) The type of renewal for the subscription.
renewal_period	any <int> (Renewal Period) The renewal period duration.
renewal_period_type	any <varchar> (Renewal Period Type) The type or unit of the renewal period. Possible values are month week year day
is_auto_renew	any <tinyint> (Is Auto Renew) Indicates whether the subscription auto-renews (1 for yes, 0 for no).
trigger_dates	any <date> (Trigger Dates) Dates or events that trigger actions related to the subscription.
invoice_separate	any <date> (Invoice the Subscription Separately) Indicates if the subscription is separately invoiced (1 for yes, 0 for no).
total_amount	any <double> (Total Amount) The total amount associated with the subscription's plan-items. Note: The total_amount value would be `0` (zero) if subscription "type" is `evergreen`
status	any <varchar> (Status) The current state of the subscription (e.g., active, suspended). Possible values are active The subscription is active and in service. pending The subscription is pending activation. draft The subscription is in draft mode. trial The subscription is in trial mode. suspended The subscription is suspended. The subscription will not renew while in this state. cancelled The subscription has been canceled and is no longer in service. expired The subscription has expired and is no longer in service.
payment_status	any <varchar> (Payment Status) The payment status of the subscription (e.g., pending, paid).
created_at	any <timestamp> (Created At) The date and time when the subscription was created.
suspended_at	any <timestamp> (Suspended At) The date and time when the subscription was suspended.
cancelled_at	any <timestamp> (Cancelled At) The date and time when the subscription was cancelled.
billing_end_date	any <date> (Billing End Date) The date when billing for the subscription ends.
updated_at	any <timestamp> (Updated At) The date and time when the subscription was last updated.
created_by	any <char> (Created By) The identifier of the user who created the subscription.
updated_by	any <char> (Updated By) The identifier of the user who last updated the subscription.
assigned_to	any <char> (Assigned To) The identifier of the user to whom the subscription is assigned.
assigned_group_id	any <char> (Assigned Group) The identifier of the group to which the subscription is assigned.
data_source	any <char> (Data Source) The source of data for the subscription.
trial_period	any <int> (Trial Period) The duration of the trial period.
trial_period_unit	any <varchar> (Trial Period Unit) The unit of the trial period duration. Possible values are days months
is_gift	any <tinyint> (Gift Subscription) Indicates if the subscription is a gift (1 for yes, 0 for no).
recipient_id	any <char> (Gift Recipient) The identifier of the recipient of the gift subscription.

Responses

Response Schema: application/json

	object
	object
	object

Request samples

Payload

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"customer_id": "__test__sf5sukSOXdulGOV",
"items": [{"plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
"product_id": "test-0596-4722-bf72-4b90008c31a5"
}
],
"name": "Premium Subscription",
"type": "evergreen",
"termed_start_date": "2023-11-01",
"termed_initial_period": 30,
"termed_initial_period_type": "days",
"renewal_type": "monthly",
"renewal_period": 30,
"renewal_period_type": "day",
"is_auto_renew": 1,
"trigger_dates": "2023-12-01",
"invoice_separate": 0,
"total_amount": 99.99,
"status": "active",
"payment_status": "paid",
"created_at": "2023-10-15T14:30:00Z",
"suspended_at": "2023-11-05T10:45:00Z",
"cancelled_at": "2023-11-20T16:15:00Z",
"billing_end_date": "2023-12-01",
"updated_at": "2023-11-25T08:20:00Z",
"created_by": "user123",
"updated_by": "admin456",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System",
"trial_period": 15,
"trial_period_unit": "days",
"is_gift": 0,
"recipient_id": "recipient123"
}

Response samples

Content type

application/json

{"data": {"type": "subscriptions",
"id": "8655a896-ebd3-4eb5-8ede-841c2b8c23f0",
"attributes": {"id": "8655a896-ebd3-4eb5-8ede-841c2b8c23f0",
"name": "subscription_4",
"display_name": "Creators Signup -> Creators Signup Plan",
"type": "Evergreen",
"termed_start_date": null,
"termed_initial_period": null,
"termed_initial_period_type": null,
"renewal_type": null,
"renewal_period_type": null,
"is_auto_renew": 0,
"trigger_dates": "2023-09-26",
"invoice_separate": "No",
"total_amount": 0,
"status": "Active",
"payment_status": "Pending",
"created_at": "2024-04-08T07:45:00+02:00",
"renewal_period": null,
"suspended_at": null,
"resume_suspended_at": null,
"renewed_at": null,
"cancelled_at": null,
"billing_end_date": null,
"next_bill_date": null,
"updated_at": "2024-04-19T12:59:00+02:00",
"data_source": "SubscriptionFlow(HPP)",
"trial_period": null,
"trial_period_unit": null,
"is_gift": 0,
"mv_indicator": null,
"mv_taken_out_of_delivery_system": null,
"mv_reason_taking_out_of_delivery_system": null,
"mv_early_renewal": 0,
"mv_new_term_start_date": "2023-09-26",
"mv_expiration_date": null,
"mv_remaining_term": null,
"mv_payment_recieved_date": null,
"customer": {"id": "User-12345",
"name": "SF DEVELOPERS",
"email": "[email protected]",
"company": null,
"phone_number": null,
"po_number": null,
"legal_entity": null,
"currency": "USD",
"billing_cycle_day": null,
"notes": null,
"image": null,
"customer_number": "CUST_2",
"terms": null,
"created_at": "2024-02-06T09:01:00+01:00",
"updated_at": "2024-06-07T15:35:00+02:00",
"portal_is_enabled": 1,
"tax_exempt": 0,
"certificate_id": null,
"certificate_type": null,
"issuing_jurisdiction": null,
"entity_use_code": null,
"description": null,
"vat_id": null,
"last_activity": "{{LBL_GENERATED_ORDER}} <a href=\"https://mobilesdk.subscriptionflow.com/en/order-detail/d2e98cbc-92d9-474b-a2fc-3c19d164d753\">O-20</a>",
"auto_charge": 1,
"billing_address_1": "",
"billing_address_2": "",
"billing_address_3": null,
"billing_city": "",
"billing_state": "",
"billing_county": null,
"billing_postal_code": "",
"billing_country": "",
"billing_name": "",
"billing_email": "",
"shipping_address_1": "",
"shipping_address_2": "",
"shipping_address_3": null,
"shipping_city": "",
"shipping_state": "",
"shipping_county": null,
"shipping_postal_code": "",
"shipping_country": "",
"shipping_name": "",
"shipping_email": "",
"data_source": "SubscriptionFlow",
"primary_churn_score_value": null,
"primary_churn_score_grade": null,
"miscellaneous_charges_exempt": null,
"invoice_payer": null,
"consolidate_invoices": null
},
"items": [{"id": "33d0f3c9-a878-4de3-93e8-3f2901bd6717",
"plan_id": "c6849c2e-4050-4b1b-a22c-9ea8a7e45a72",
"product_id": "edf1ff75-0eb4-4c64-9c5d-c7315a378afd",
"coupon_id": null,
"plan_name": "Normal Plan",
"plan_description": "This is a normal plan",
"product_name": "MonthlySubscription",
"product_description": null,
"charges": [{"id": "c15d0bcc-524c-4e6f-8c62-a8159c725247",
"plan_price_id": "1c0346d0-dcc1-4538-b423-4522138e55d3",
"category": "onetime",
"charge_model": "flat_fee",
"list_price": 10,
"list_price_base": null,
"uom": null,
"included_units": null,
"default_quantity": "1",
"taxable": null,
"tax_mode": null,
"tax_id": null,
"bill_date": null,
"billing_period_id": null,
"name": "Normal Plan",
"plan_price": {"id": "1c0346d0-dcc1-4538-b423-4522138e55d3",
"plan_id": "c6849c2e-4050-4b1b-a22c-9ea8a7e45a72",
"product_id": "edf1ff75-0eb4-4c64-9c5d-c7315a378afd",
"name": "Normal Plan",
"description": null,
"category": "onetime",
"charge_model": "flat_fee",
"list_price": {"USD": "10"
},
"list_price_base": null,
"uom": null,
"included_units": null,
"default_quantity": null,
"trigger_condition": null,
"end_date": null,
"billing_timming": 0,
"billing_period_alignment": null,
"usage_records_rating_option": null,
"created_at": "02/06/2024 13:11",
"updated_at": "02/06/2024 13:11",
"created_by": null,
"updated_by": null,
"taxable": null,
"tax_mode": null,
"tax_id": null,
"assigned_to": null,
"billing_period_id": null,
"billing_period_months_weeks": null,
"billing_month_id": null,
"billing_day_type_id": null,
"billing_week_day_id": null,
"deleted_at": null,
"accounting_account_code": null,
"data_source": "SubscriptionFlow",
"billing_year_month_id": null,
"cost_price": null,
"additional_field": null,
"second_additional_field": null
}
}
]
}
]
}
},
"relationships": {"customer_id": {"id": "User-12345",
"link": "https://mobilesdk.subscriptionflow.com/api/v1/customers/User-12345",
"created_by": {"id": "bed76993-640d-453a-ac4d-67c4a106ec48",
"link": "https://mobilesdk.subscriptionflow.com/api/v1/users/bed76993-640d-453a-ac4d-67c4a106ec48"
},
"updated_by": {"id": "bed76993-640d-453a-ac4d-67c4a106ec48",
"link": "https://mobilesdk.subscriptionflow.com/api/v1/users/bed76993-640d-453a-ac4d-67c4a106ec48"
},
"assigned_to": {"id": "bed76993-640d-453a-ac4d-67c4a106ec48",
"link": "https://mobilesdk.subscriptionflow.com/api/v1/users/bed76993-640d-453a-ac4d-67c4a106ec48"
},
"assigned_group_id": null,
"recipient_id": null,
"tax_id": null
}
},
"links": {"self": "https://mobilesdk.subscriptionflow.com/api/v1/subscriptions/8655a896-ebd3-4eb5-8ede-841c2b8c23f0",
"app_url": "https://mobilesdk.subscriptionflow.com/subscription-detail/8655a896-ebd3-4eb5-8ede-841c2b8c23f0"
}
}

Delete existing Subscription

Remove a specific subscription from the database. This operation requires the subscription ID to identify and delete the subscription.

path Parameters

subscription_id

required

string

The unique identifier of subscription

Responses

Response samples

Content type

application/json

{"data": {"type": "subscriptions",
"id": "8655a896-ebd3-4eb5-8ede-841c2b8c23f0",
"attributes": {"id": "8655a896-ebd3-4eb5-8ede-841c2b8c23f0",
"name": "subscription_4",
"display_name": "Creators Signup -> Creators Signup Plan",
"type": "Evergreen",
"termed_start_date": null,
"termed_initial_period": null,
"termed_initial_period_type": null,
"renewal_type": null,
"renewal_period_type": null,
"is_auto_renew": 0,
"trigger_dates": "2023-09-26",
"invoice_separate": "No",
"total_amount": 0,
"status": "Active",
"payment_status": "Pending",
"created_at": "2024-04-08T07:45:00+02:00",
"renewal_period": null,
"suspended_at": null,
"resume_suspended_at": null,
"renewed_at": null,
"cancelled_at": null,
"billing_end_date": null,
"next_bill_date": null,
"updated_at": "2024-04-19T12:59:00+02:00",
"data_source": "SubscriptionFlow(HPP)",
"trial_period": null,
"trial_period_unit": null,
"is_gift": 0,
"mv_indicator": null,
"mv_taken_out_of_delivery_system": null,
"mv_reason_taking_out_of_delivery_system": null,
"mv_early_renewal": 0,
"mv_new_term_start_date": "2023-09-26",
"mv_expiration_date": null,
"mv_remaining_term": null,
"mv_payment_recieved_date": null,
"customer": {"id": "User-12345",
"name": "SF DEVELOPERS",
"email": "[email protected]",
"company": null,
"phone_number": null,
"po_number": null,
"legal_entity": null,
"currency": "USD",
"billing_cycle_day": null,
"notes": null,
"image": null,
"customer_number": "CUST_2",
"terms": null,
"created_at": "2024-02-06T09:01:00+01:00",
"updated_at": "2024-06-07T15:35:00+02:00",
"portal_is_enabled": 1,
"tax_exempt": 0,
"certificate_id": null,
"certificate_type": null,
"issuing_jurisdiction": null,
"entity_use_code": null,
"description": null,
"vat_id": null,
"last_activity": "{{LBL_GENERATED_ORDER}} <a href=\"https://mobilesdk.subscriptionflow.com/en/order-detail/d2e98cbc-92d9-474b-a2fc-3c19d164d753\">O-20</a>",
"auto_charge": 1,
"billing_address_1": "",
"billing_address_2": "",
"billing_address_3": null,
"billing_city": "",
"billing_state": "",
"billing_county": null,
"billing_postal_code": "",
"billing_country": "",
"billing_name": "",
"billing_email": "",
"shipping_address_1": "",
"shipping_address_2": "",
"shipping_address_3": null,
"shipping_city": "",
"shipping_state": "",
"shipping_county": null,
"shipping_postal_code": "",
"shipping_country": "",
"shipping_name": "",
"shipping_email": "",
"data_source": "SubscriptionFlow",
"primary_churn_score_value": null,
"primary_churn_score_grade": null,
"miscellaneous_charges_exempt": null,
"invoice_payer": null,
"consolidate_invoices": null
},
"items": [{"id": "33d0f3c9-a878-4de3-93e8-3f2901bd6717",
"plan_id": "c6849c2e-4050-4b1b-a22c-9ea8a7e45a72",
"product_id": "edf1ff75-0eb4-4c64-9c5d-c7315a378afd",
"coupon_id": null,
"plan_name": "Normal Plan",
"plan_description": "This is a normal plan",
"product_name": "MonthlySubscription",
"product_description": null,
"charges": [{"id": "c15d0bcc-524c-4e6f-8c62-a8159c725247",
"plan_price_id": "1c0346d0-dcc1-4538-b423-4522138e55d3",
"category": "onetime",
"charge_model": "flat_fee",
"list_price": 10,
"list_price_base": null,
"uom": null,
"included_units": null,
"default_quantity": "1",
"taxable": null,
"tax_mode": null,
"tax_id": null,
"bill_date": null,
"billing_period_id": null,
"name": "Normal Plan",
"plan_price": {"id": "1c0346d0-dcc1-4538-b423-4522138e55d3",
"plan_id": "c6849c2e-4050-4b1b-a22c-9ea8a7e45a72",
"product_id": "edf1ff75-0eb4-4c64-9c5d-c7315a378afd",
"name": "Normal Plan",
"description": null,
"category": "onetime",
"charge_model": "flat_fee",
"list_price": {"USD": "10"
},
"list_price_base": null,
"uom": null,
"included_units": null,
"default_quantity": null,
"trigger_condition": null,
"end_date": null,
"billing_timming": 0,
"billing_period_alignment": null,
"usage_records_rating_option": null,
"created_at": "02/06/2024 13:11",
"updated_at": "02/06/2024 13:11",
"created_by": null,
"updated_by": null,
"taxable": null,
"tax_mode": null,
"tax_id": null,
"assigned_to": null,
"billing_period_id": null,
"billing_period_months_weeks": null,
"billing_month_id": null,
"billing_day_type_id": null,
"billing_week_day_id": null,
"deleted_at": null,
"accounting_account_code": null,
"data_source": "SubscriptionFlow",
"billing_year_month_id": null,
"cost_price": null,
"additional_field": null,
"second_additional_field": null
}
}
]
}
]
}
},
"relationships": {"customer_id": {"id": "User-12345",
"link": "https://mobilesdk.subscriptionflow.com/api/v1/customers/User-12345",
"created_by": {"id": "bed76993-640d-453a-ac4d-67c4a106ec48",
"link": "https://mobilesdk.subscriptionflow.com/api/v1/users/bed76993-640d-453a-ac4d-67c4a106ec48"
},
"updated_by": {"id": "bed76993-640d-453a-ac4d-67c4a106ec48",
"link": "https://mobilesdk.subscriptionflow.com/api/v1/users/bed76993-640d-453a-ac4d-67c4a106ec48"
},
"assigned_to": {"id": "bed76993-640d-453a-ac4d-67c4a106ec48",
"link": "https://mobilesdk.subscriptionflow.com/api/v1/users/bed76993-640d-453a-ac4d-67c4a106ec48"
},
"assigned_group_id": null,
"recipient_id": null,
"tax_id": null
}
},
"links": {"self": "https://mobilesdk.subscriptionflow.com/api/v1/subscriptions/8655a896-ebd3-4eb5-8ede-841c2b8c23f0",
"app_url": "https://mobilesdk.subscriptionflow.com/subscription-detail/8655a896-ebd3-4eb5-8ede-841c2b8c23f0"
}
}

Get with-relations list of Subscriptions

Returns list of Subscriptions with all foreign keys

Responses

Response Schema: application/json

id	any <varchar> (Id) A unique and immutable identifier for the subscription.
customer_id	any <char> (Customer) Identifier of the customer with whom this subscription is associated.
items	any <array> (Items) Identifier of the plan and product with whom this subscription is associated.
name	any <varchar> (Name) The name associated with this subscription.
type	any <varchar> (Type) The type or category of the subscription. Possible values are Termed Evergreen
termed_start_date	any <date> (Term Start Date) The date when the subscription's term starts.
termed_initial_period	any <int> (Term Initial Period) The initial period of the subscription term.
termed_initial_period_type	any <varchar> (Term Initial Period Type) The type or unit of the initial period. Possible values are month week year day
renewal_type	any <varchar> (Renewal Type) The type of renewal for the subscription.
renewal_period	any <int> (Renewal Period) The renewal period duration.
renewal_period_type	any <varchar> (Renewal Period Type) The type or unit of the renewal period. Possible values are month week year day
is_auto_renew	any <tinyint> (Is Auto Renew) Indicates whether the subscription auto-renews (1 for yes, 0 for no).
trigger_dates	any <date> (Trigger Dates) Dates or events that trigger actions related to the subscription.
invoice_separate	any <date> (Invoice the Subscription Separately) Indicates if the subscription is separately invoiced (1 for yes, 0 for no).
total_amount	any <double> (Total Amount) The total amount associated with the subscription's plan-items. Note: The total_amount value would be `0` (zero) if subscription "type" is `evergreen`
status	any <varchar> (Status) The current state of the subscription (e.g., active, suspended). Possible values are active The subscription is active and in service. pending The subscription is pending activation. draft The subscription is in draft mode. trial The subscription is in trial mode. suspended The subscription is suspended. The subscription will not renew while in this state. cancelled The subscription has been canceled and is no longer in service. expired The subscription has expired and is no longer in service.
payment_status	any <varchar> (Payment Status) The payment status of the subscription (e.g., pending, paid).
created_at	any <timestamp> (Created At) The date and time when the subscription was created.
suspended_at	any <timestamp> (Suspended At) The date and time when the subscription was suspended.
cancelled_at	any <timestamp> (Cancelled At) The date and time when the subscription was cancelled.
billing_end_date	any <date> (Billing End Date) The date when billing for the subscription ends.
updated_at	any <timestamp> (Updated At) The date and time when the subscription was last updated.
created_by	any <char> (Created By) The identifier of the user who created the subscription.
updated_by	any <char> (Updated By) The identifier of the user who last updated the subscription.
assigned_to	any <char> (Assigned To) The identifier of the user to whom the subscription is assigned.
assigned_group_id	any <char> (Assigned Group) The identifier of the group to which the subscription is assigned.
data_source	any <char> (Data Source) The source of data for the subscription.
trial_period	any <int> (Trial Period) The duration of the trial period.
trial_period_unit	any <varchar> (Trial Period Unit) The unit of the trial period duration. Possible values are days months
is_gift	any <tinyint> (Gift Subscription) Indicates if the subscription is a gift (1 for yes, 0 for no).
recipient_id	any <char> (Gift Recipient) The identifier of the recipient of the gift subscription.

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"customer_id": "__test__sf5sukSOXdulGOV",
"items": [{"plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
"product_id": "test-0596-4722-bf72-4b90008c31a5"
}
],
"name": "Premium Subscription",
"type": "evergreen",
"termed_start_date": "2023-11-01",
"termed_initial_period": 30,
"termed_initial_period_type": "days",
"renewal_type": "monthly",
"renewal_period": 30,
"renewal_period_type": "day",
"is_auto_renew": 1,
"trigger_dates": "2023-12-01",
"invoice_separate": 0,
"total_amount": 99.99,
"status": "active",
"payment_status": "paid",
"created_at": "2023-10-15T14:30:00Z",
"suspended_at": "2023-11-05T10:45:00Z",
"cancelled_at": "2023-11-20T16:15:00Z",
"billing_end_date": "2023-12-01",
"updated_at": "2023-11-25T08:20:00Z",
"created_by": "user123",
"updated_by": "admin456",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System",
"trial_period": 15,
"trial_period_unit": "days",
"is_gift": 0,
"recipient_id": "recipient123"
}

Get related list of Subscriptions

Returns one-to-many list of Subscriptions with related Module

path Parameters

subscription_id required	string The unique identifier of subscription
related required	varchar The name of the relation you want to link with subscription query. hasMany relation name

Responses

Response Schema: application/json

id	any <varchar> (Id) A unique and immutable identifier for the subscription.
customer_id	any <char> (Customer) Identifier of the customer with whom this subscription is associated.
items	any <array> (Items) Identifier of the plan and product with whom this subscription is associated.
name	any <varchar> (Name) The name associated with this subscription.
type	any <varchar> (Type) The type or category of the subscription. Possible values are Termed Evergreen
termed_start_date	any <date> (Term Start Date) The date when the subscription's term starts.
termed_initial_period	any <int> (Term Initial Period) The initial period of the subscription term.
termed_initial_period_type	any <varchar> (Term Initial Period Type) The type or unit of the initial period. Possible values are month week year day
renewal_type	any <varchar> (Renewal Type) The type of renewal for the subscription.
renewal_period	any <int> (Renewal Period) The renewal period duration.
renewal_period_type	any <varchar> (Renewal Period Type) The type or unit of the renewal period. Possible values are month week year day
is_auto_renew	any <tinyint> (Is Auto Renew) Indicates whether the subscription auto-renews (1 for yes, 0 for no).
trigger_dates	any <date> (Trigger Dates) Dates or events that trigger actions related to the subscription.
invoice_separate	any <date> (Invoice the Subscription Separately) Indicates if the subscription is separately invoiced (1 for yes, 0 for no).
total_amount	any <double> (Total Amount) The total amount associated with the subscription's plan-items. Note: The total_amount value would be `0` (zero) if subscription "type" is `evergreen`
status	any <varchar> (Status) The current state of the subscription (e.g., active, suspended). Possible values are active The subscription is active and in service. pending The subscription is pending activation. draft The subscription is in draft mode. trial The subscription is in trial mode. suspended The subscription is suspended. The subscription will not renew while in this state. cancelled The subscription has been canceled and is no longer in service. expired The subscription has expired and is no longer in service.
payment_status	any <varchar> (Payment Status) The payment status of the subscription (e.g., pending, paid).
created_at	any <timestamp> (Created At) The date and time when the subscription was created.
suspended_at	any <timestamp> (Suspended At) The date and time when the subscription was suspended.
cancelled_at	any <timestamp> (Cancelled At) The date and time when the subscription was cancelled.
billing_end_date	any <date> (Billing End Date) The date when billing for the subscription ends.
updated_at	any <timestamp> (Updated At) The date and time when the subscription was last updated.
created_by	any <char> (Created By) The identifier of the user who created the subscription.
updated_by	any <char> (Updated By) The identifier of the user who last updated the subscription.
assigned_to	any <char> (Assigned To) The identifier of the user to whom the subscription is assigned.
assigned_group_id	any <char> (Assigned Group) The identifier of the group to which the subscription is assigned.
data_source	any <char> (Data Source) The source of data for the subscription.
trial_period	any <int> (Trial Period) The duration of the trial period.
trial_period_unit	any <varchar> (Trial Period Unit) The unit of the trial period duration. Possible values are days months
is_gift	any <tinyint> (Gift Subscription) Indicates if the subscription is a gift (1 for yes, 0 for no).
recipient_id	any <char> (Gift Recipient) The identifier of the recipient of the gift subscription.

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"customer_id": "__test__sf5sukSOXdulGOV",
"items": [{"plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
"product_id": "test-0596-4722-bf72-4b90008c31a5"
}
],
"name": "Premium Subscription",
"type": "evergreen",
"termed_start_date": "2023-11-01",
"termed_initial_period": 30,
"termed_initial_period_type": "days",
"renewal_type": "monthly",
"renewal_period": 30,
"renewal_period_type": "day",
"is_auto_renew": 1,
"trigger_dates": "2023-12-01",
"invoice_separate": 0,
"total_amount": 99.99,
"status": "active",
"payment_status": "paid",
"created_at": "2023-10-15T14:30:00Z",
"suspended_at": "2023-11-05T10:45:00Z",
"cancelled_at": "2023-11-20T16:15:00Z",
"billing_end_date": "2023-12-01",
"updated_at": "2023-11-25T08:20:00Z",
"created_by": "user123",
"updated_by": "admin456",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System",
"trial_period": 15,
"trial_period_unit": "days",
"is_gift": 0,
"recipient_id": "recipient123"
}

Get filtered list of Subscriptions

Returns list of Subscriptions with quick filters

path Parameters

fieldName

required

varchar

Field name to apply filter E.g. 'name' = 'John'

Responses

Response Schema: application/json

id	any <varchar> (Id) A unique and immutable identifier for the subscription.
customer_id	any <char> (Customer) Identifier of the customer with whom this subscription is associated.
items	any <array> (Items) Identifier of the plan and product with whom this subscription is associated.
name	any <varchar> (Name) The name associated with this subscription.
type	any <varchar> (Type) The type or category of the subscription. Possible values are Termed Evergreen
termed_start_date	any <date> (Term Start Date) The date when the subscription's term starts.
termed_initial_period	any <int> (Term Initial Period) The initial period of the subscription term.
termed_initial_period_type	any <varchar> (Term Initial Period Type) The type or unit of the initial period. Possible values are month week year day
renewal_type	any <varchar> (Renewal Type) The type of renewal for the subscription.
renewal_period	any <int> (Renewal Period) The renewal period duration.
renewal_period_type	any <varchar> (Renewal Period Type) The type or unit of the renewal period. Possible values are month week year day
is_auto_renew	any <tinyint> (Is Auto Renew) Indicates whether the subscription auto-renews (1 for yes, 0 for no).
trigger_dates	any <date> (Trigger Dates) Dates or events that trigger actions related to the subscription.
invoice_separate	any <date> (Invoice the Subscription Separately) Indicates if the subscription is separately invoiced (1 for yes, 0 for no).
total_amount	any <double> (Total Amount) The total amount associated with the subscription's plan-items. Note: The total_amount value would be `0` (zero) if subscription "type" is `evergreen`
status	any <varchar> (Status) The current state of the subscription (e.g., active, suspended). Possible values are active The subscription is active and in service. pending The subscription is pending activation. draft The subscription is in draft mode. trial The subscription is in trial mode. suspended The subscription is suspended. The subscription will not renew while in this state. cancelled The subscription has been canceled and is no longer in service. expired The subscription has expired and is no longer in service.
payment_status	any <varchar> (Payment Status) The payment status of the subscription (e.g., pending, paid).
created_at	any <timestamp> (Created At) The date and time when the subscription was created.
suspended_at	any <timestamp> (Suspended At) The date and time when the subscription was suspended.
cancelled_at	any <timestamp> (Cancelled At) The date and time when the subscription was cancelled.
billing_end_date	any <date> (Billing End Date) The date when billing for the subscription ends.
updated_at	any <timestamp> (Updated At) The date and time when the subscription was last updated.
created_by	any <char> (Created By) The identifier of the user who created the subscription.
updated_by	any <char> (Updated By) The identifier of the user who last updated the subscription.
assigned_to	any <char> (Assigned To) The identifier of the user to whom the subscription is assigned.
assigned_group_id	any <char> (Assigned Group) The identifier of the group to which the subscription is assigned.
data_source	any <char> (Data Source) The source of data for the subscription.
trial_period	any <int> (Trial Period) The duration of the trial period.
trial_period_unit	any <varchar> (Trial Period Unit) The unit of the trial period duration. Possible values are days months
is_gift	any <tinyint> (Gift Subscription) Indicates if the subscription is a gift (1 for yes, 0 for no).
recipient_id	any <char> (Gift Recipient) The identifier of the recipient of the gift subscription.

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"customer_id": "__test__sf5sukSOXdulGOV",
"items": [{"plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
"product_id": "test-0596-4722-bf72-4b90008c31a5"
}
],
"name": "Premium Subscription",
"type": "evergreen",
"termed_start_date": "2023-11-01",
"termed_initial_period": 30,
"termed_initial_period_type": "days",
"renewal_type": "monthly",
"renewal_period": 30,
"renewal_period_type": "day",
"is_auto_renew": 1,
"trigger_dates": "2023-12-01",
"invoice_separate": 0,
"total_amount": 99.99,
"status": "active",
"payment_status": "paid",
"created_at": "2023-10-15T14:30:00Z",
"suspended_at": "2023-11-05T10:45:00Z",
"cancelled_at": "2023-11-20T16:15:00Z",
"billing_end_date": "2023-12-01",
"updated_at": "2023-11-25T08:20:00Z",
"created_by": "user123",
"updated_by": "admin456",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System",
"trial_period": 15,
"trial_period_unit": "days",
"is_gift": 0,
"recipient_id": "recipient123"
}

Filter Subscription with nested conditions

Returns filtered Subscription data

query Parameters

$equals	varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value'
$not_equals	varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value'
$starts	varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value'
$ends	varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value'
$contains	varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value'
$in	varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second']
$is_null	varchar Match if field have null value. E.g. filter[column_name][$is_null] = true
$not_null	varchar Match if field is not null. E.g. filter[column_name][$not_null] = true
$not_in	varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second']
$lt	varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value'
$lte	varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value'
$gt	varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value'
$gte	varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value'
$sortorder	varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc\|desc'
$limit	varchar Limit results E.g. filter[$limit] = '50' \| For offset: filter[$offset] = '20'
$paginate	varchar Paginate results E.g. filter[$paginate] = '50

Responses

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"customer_id": "__test__sf5sukSOXdulGOV",
"items": [{"plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
"product_id": "test-0596-4722-bf72-4b90008c31a5"
}
],
"name": "Premium Subscription",
"type": "evergreen",
"termed_start_date": "2023-11-01",
"termed_initial_period": 30,
"termed_initial_period_type": "days",
"renewal_type": "monthly",
"renewal_period": 30,
"renewal_period_type": "day",
"is_auto_renew": 1,
"trigger_dates": "2023-12-01",
"invoice_separate": 0,
"total_amount": 99.99,
"status": "active",
"payment_status": "paid",
"created_at": "2023-10-15T14:30:00Z",
"suspended_at": "2023-11-05T10:45:00Z",
"cancelled_at": "2023-11-20T16:15:00Z",
"billing_end_date": "2023-12-01",
"updated_at": "2023-11-25T08:20:00Z",
"created_by": "user123",
"updated_by": "admin456",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System",
"trial_period": 15,
"trial_period_unit": "days",
"is_gift": 0,
"recipient_id": "recipient123"
}

Bulk destroy Subscriptions

Returns deleted Subscriptions data

query Parameters

ids

required

varchar

Array of ids to be deleted.

Responses

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"customer_id": "__test__sf5sukSOXdulGOV",
"items": [{"plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
"product_id": "test-0596-4722-bf72-4b90008c31a5"
}
],
"name": "Premium Subscription",
"type": "evergreen",
"termed_start_date": "2023-11-01",
"termed_initial_period": 30,
"termed_initial_period_type": "days",
"renewal_type": "monthly",
"renewal_period": 30,
"renewal_period_type": "day",
"is_auto_renew": 1,
"trigger_dates": "2023-12-01",
"invoice_separate": 0,
"total_amount": 99.99,
"status": "active",
"payment_status": "paid",
"created_at": "2023-10-15T14:30:00Z",
"suspended_at": "2023-11-05T10:45:00Z",
"cancelled_at": "2023-11-20T16:15:00Z",
"billing_end_date": "2023-12-01",
"updated_at": "2023-11-25T08:20:00Z",
"created_by": "user123",
"updated_by": "admin456",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System",
"trial_period": 15,
"trial_period_unit": "days",
"is_gift": 0,
"recipient_id": "recipient123"
}

Suspend Subscription

Temporarily suspend a specific subscription. This operation requires the subscription ID to identify and suspend the subscription.

path Parameters

subscription_id

required

string

The unique identifier of subscription

Request Body schema: application/x-www-form-urlencoded
required

suspension_option required	string The suspension option to use. Possible values are: `Today` `End of Last Invoice Period` `Specific Date` `End of Current Term`
date	string <y-m-d> Date of suspension. Note: This field is required if `suspension_option` is set to `Specific Date`.

Responses

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"customer_id": "__test__sf5sukSOXdulGOV",
"items": [{"plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
"product_id": "test-0596-4722-bf72-4b90008c31a5"
}
],
"name": "Premium Subscription",
"type": "evergreen",
"termed_start_date": "2023-11-01",
"termed_initial_period": 30,
"termed_initial_period_type": "days",
"renewal_type": "monthly",
"renewal_period": 30,
"renewal_period_type": "day",
"is_auto_renew": 1,
"trigger_dates": "2023-12-01",
"invoice_separate": 0,
"total_amount": 99.99,
"status": "active",
"payment_status": "paid",
"created_at": "2023-10-15T14:30:00Z",
"suspended_at": "2023-11-05T10:45:00Z",
"cancelled_at": "2023-11-20T16:15:00Z",
"billing_end_date": "2023-12-01",
"updated_at": "2023-11-25T08:20:00Z",
"created_by": "user123",
"updated_by": "admin456",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System",
"trial_period": 15,
"trial_period_unit": "days",
"is_gift": 0,
"recipient_id": "recipient123"
}

Resume Subscription

Reactivate a previously suspended subscription. Provide the subscription ID to resume the subscription.

path Parameters

subscription_id

required

string

The unique identifier of subscription

Request Body schema: application/x-www-form-urlencoded
required

resume_option required	string The resume option to use. Possible values are: `Today` `End of Last Invoice Period` `Specific Date` `End of Current Term`
date	string <y-m-d> Date of resume. Note: This field is required if `resume_option` is set to `Specific Date`.

Responses

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"customer_id": "__test__sf5sukSOXdulGOV",
"items": [{"plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
"product_id": "test-0596-4722-bf72-4b90008c31a5"
}
],
"name": "Premium Subscription",
"type": "evergreen",
"termed_start_date": "2023-11-01",
"termed_initial_period": 30,
"termed_initial_period_type": "days",
"renewal_type": "monthly",
"renewal_period": 30,
"renewal_period_type": "day",
"is_auto_renew": 1,
"trigger_dates": "2023-12-01",
"invoice_separate": 0,
"total_amount": 99.99,
"status": "active",
"payment_status": "paid",
"created_at": "2023-10-15T14:30:00Z",
"suspended_at": "2023-11-05T10:45:00Z",
"cancelled_at": "2023-11-20T16:15:00Z",
"billing_end_date": "2023-12-01",
"updated_at": "2023-11-25T08:20:00Z",
"created_by": "user123",
"updated_by": "admin456",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System",
"trial_period": 15,
"trial_period_unit": "days",
"is_gift": 0,
"recipient_id": "recipient123"
}

Cancel Subscription

Permanently cancel a specific subscription. This operation requires the subscription ID to identify and cancel the subscription.

path Parameters

subscription_id

required

string

The unique identifier of subscription

Request Body schema: application/x-www-form-urlencoded
required

cancellation_option required	string The cancellation option to use. Possible values are: `Today` `End of Last Invoice Period` `Specific Date` `End of Current Term`
date	string <y-m-d> Date of cancellation. Note: This field is required if `cancellation_option` is set to `Specific Date`.

Responses

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"customer_id": "__test__sf5sukSOXdulGOV",
"items": [{"plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
"product_id": "test-0596-4722-bf72-4b90008c31a5"
}
],
"name": "Premium Subscription",
"type": "evergreen",
"termed_start_date": "2023-11-01",
"termed_initial_period": 30,
"termed_initial_period_type": "days",
"renewal_type": "monthly",
"renewal_period": 30,
"renewal_period_type": "day",
"is_auto_renew": 1,
"trigger_dates": "2023-12-01",
"invoice_separate": 0,
"total_amount": 99.99,
"status": "active",
"payment_status": "paid",
"created_at": "2023-10-15T14:30:00Z",
"suspended_at": "2023-11-05T10:45:00Z",
"cancelled_at": "2023-11-20T16:15:00Z",
"billing_end_date": "2023-12-01",
"updated_at": "2023-11-25T08:20:00Z",
"created_by": "user123",
"updated_by": "admin456",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System",
"trial_period": 15,
"trial_period_unit": "days",
"is_gift": 0,
"recipient_id": "recipient123"
}

Usages

A usage is a record of a customer's usage of a product or service. The usage details include the usage ID, name, customer ID, subscription ID, charge ID, status, quantity, start date, end date, and description.

Get list of Usages

Retrieve a comprehensive list of all recorded usages. This endpoint returns an overview of each usage entry, including key details and metrics.

Responses

Response Schema: application/json

	Array of objects
	object
	object

Response samples

Content type

application/json

{"data": [{"id": "be86ee97-90b7-4f4d-a4d5-b79741f1b3a6",
"name": "System generated usage from default quantity of plan price",
"status": "Processed",
"quantity": 1,
"start_date": "2023-03-05",
"end_date": "2023-03-05",
"description": null,
"created_at": "2023-03-05T05:00:00+00:00",
"data_source": "SubscriptionFlow"
}
],
"links": {"first": "https://demo.subscriptionflow.com/api/v1/usages?page=1",
"last": "https://demo.subscriptionflow.com/api/v1/usages?page=1",
"prev": null,
"next": null
},
"meta": {"current_page": 1,
"from": 1,
"last_page": 1,
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
}
],
"path": "https://demo.subscriptionflow.com/api/v1/usages",
"per_page": 200,
"to": 9,
"total": 9
}
}

Store a new Usage

Create and record a new usage entry in the system. Provide the necessary details in the request body to successfully log the new usage.

path Parameters

title	string The title of your note.
description	string The description of your notes.
noteable_id	string The noteable_id specifies the ID of the associated object.
noteable_type	string The noteable_type denotes the type of the associated object (e.g., customers, subscriptions, invoices).

Request Body schema: application/json

id	any <varchar> (Id) A unique and immutable identifier for the usage.
name	any <varchar> (Name) The name associated with this usage. This is the name of the usage item. For example, "Data Usage".
customer_id	any <varchar> (Customer) Identifier of the customer with whom this usage is associated.
subscription_id	any <varchar> (Subscription) Identifier of the subscription with which this usage is associated.
charge_id	any <varchar> (Charge) Identifier of the charge with which this usage is associated.
status	any <varchar> (Status) The current state of the usage (e.g., processed)
quantity	any <double> (Quantity) The quantity of the usage.
start_date	any <date> (Start Date) The date when the usage starts.
end_date	any <date> (End Date) The date when the usage ends.
description	any <text> (Description) The description of the usage.
created_at	any <datetime> (Created At) The date and time when the usage was created.
assigned_to	any <char> (Assigned To) The identifier of the user to whom the usage is assigned.
data_source	any <char> (Data Source) The source of data for the usage.

Responses

Request samples

Payload

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"name": "Data Usage",
"customer_id": "__test__sf5sukSOXdulGOV",
"subscription_id": "__test__sf5sukSOXdulGOV",
"charge_id": "__test__sf5sukSOXdulGOV",
"status": "processed",
"quantity": 100,
"start_date": "2023-11-01",
"end_date": "2023-11-30",
"description": "Data Usage",
"created_at": "2023-10-15T14:30:00Z",
"assigned_to": "user789",
"data_source": "System"
}

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"name": "Data Usage",
"customer_id": "__test__sf5sukSOXdulGOV",
"subscription_id": "__test__sf5sukSOXdulGOV",
"charge_id": "__test__sf5sukSOXdulGOV",
"status": "processed",
"quantity": 100,
"start_date": "2023-11-01",
"end_date": "2023-11-30",
"description": "Data Usage",
"created_at": "2023-10-15T14:30:00Z",
"assigned_to": "user789",
"data_source": "System"
}

Get Usage information

Retrieve detailed information about a specific usage entry. This operation requires the usage ID to fetch and display the relevant usage data.

path Parameters

usage_id

required

string

The unique identifier of usage

Responses

Response Schema: application/json

object

Response samples

Content type

application/json

{"data": {"type": "usages",
"id": "be86ee97-90b7-4f4d-a4d5-b79741f1b3a6",
"attributes": {"id": "be86ee97-90b7-4f4d-a4d5-b79741f1b3a6",
"name": "System generated usage from default quantity of plan price",
"status": "Processed",
"quantity": 1,
"start_date": "2023-03-05",
"end_date": "2023-03-05",
"description": null,
"created_at": "2023-03-05T05:00:00+00:00",
"data_source": "SubscriptionFlow"
},
"relationships": {"customer_id": {"id": "e2c3926e-801d-4cc2-ac3b-14d70a8de3bf",
"link": "https://demo.subscriptionflow.com/api/v1/customers/e2c3926e-801d-4cc2-ac3b-14d70a8de3bf"
},
"subscription_id": {"id": "d38fc9ee-56d2-4cfc-a133-20f92bee24da",
"link": "https://demo.subscriptionflow.com/api/v1/subscriptions/d38fc9ee-56d2-4cfc-a133-20f92bee24da"
},
"charge_id": null,
"assigned_to": null
},
"links": {"self": "https://demo.subscriptionflow.com/api/v1/usages/be86ee97-90b7-4f4d-a4d5-b79741f1b3a6",
"app_url": "https://demo.subscriptionflow.com/usage-detail/be86ee97-90b7-4f4d-a4d5-b79741f1b3a6"
}
}
}

Update existing Usage

Modify the details of an existing usage entry. Provide the usage ID and updated information in the request body to apply the changes.

path Parameters

usage_id

required

string

The unique identifier of usage

Request Body schema: application/json
required

id	any <varchar> (Id) A unique and immutable identifier for the usage.
name	any <varchar> (Name) The name associated with this usage. This is the name of the usage item. For example, "Data Usage".
customer_id	any <varchar> (Customer) Identifier of the customer with whom this usage is associated.
subscription_id	any <varchar> (Subscription) Identifier of the subscription with which this usage is associated.
charge_id	any <varchar> (Charge) Identifier of the charge with which this usage is associated.
status	any <varchar> (Status) The current state of the usage (e.g., processed)
quantity	any <double> (Quantity) The quantity of the usage.
start_date	any <date> (Start Date) The date when the usage starts.
end_date	any <date> (End Date) The date when the usage ends.
description	any <text> (Description) The description of the usage.
created_at	any <datetime> (Created At) The date and time when the usage was created.
assigned_to	any <char> (Assigned To) The identifier of the user to whom the usage is assigned.
data_source	any <char> (Data Source) The source of data for the usage.

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"name": "Data Usage",
"customer_id": "__test__sf5sukSOXdulGOV",
"subscription_id": "__test__sf5sukSOXdulGOV",
"charge_id": "__test__sf5sukSOXdulGOV",
"status": "processed",
"quantity": 100,
"start_date": "2023-11-01",
"end_date": "2023-11-30",
"description": "Data Usage",
"created_at": "2023-10-15T14:30:00Z",
"assigned_to": "user789",
"data_source": "System"
}

Response samples

Content type

application/json

{"data": {"type": "usages",
"id": "be86ee97-90b7-4f4d-a4d5-b79741f1b3a6",
"attributes": {"id": "be86ee97-90b7-4f4d-a4d5-b79741f1b3a6",
"name": "System generated usage from default quantity of plan price",
"status": "Processed",
"quantity": 1,
"start_date": "2023-03-05",
"end_date": "2023-03-05",
"description": null,
"created_at": "2023-03-05T05:00:00+00:00",
"data_source": "SubscriptionFlow"
},
"relationships": {"customer_id": {"id": "e2c3926e-801d-4cc2-ac3b-14d70a8de3bf",
"link": "https://demo.subscriptionflow.com/api/v1/customers/e2c3926e-801d-4cc2-ac3b-14d70a8de3bf"
},
"subscription_id": {"id": "d38fc9ee-56d2-4cfc-a133-20f92bee24da",
"link": "https://demo.subscriptionflow.com/api/v1/subscriptions/d38fc9ee-56d2-4cfc-a133-20f92bee24da"
},
"charge_id": null,
"assigned_to": null
},
"links": {"self": "https://demo.subscriptionflow.com/api/v1/usages/be86ee97-90b7-4f4d-a4d5-b79741f1b3a6",
"app_url": "https://demo.subscriptionflow.com/usage-detail/be86ee97-90b7-4f4d-a4d5-b79741f1b3a6"
}
}
}

Delete existing Usage

Permanently remove a specific usage entry from the system. This operation requires the usage ID to identify and delete the usage record.

path Parameters

usage_id

required

string

The unique identifier of usage

Responses

Response samples

Content type

application/json

{"data": {"type": "usages",
"id": "be86ee97-90b7-4f4d-a4d5-b79741f1b3a6",
"attributes": {"id": "be86ee97-90b7-4f4d-a4d5-b79741f1b3a6",
"name": "System generated usage from default quantity of plan price",
"status": "Processed",
"quantity": 1,
"start_date": "2023-03-05",
"end_date": "2023-03-05",
"description": null,
"created_at": "2023-03-05T05:00:00+00:00",
"data_source": "SubscriptionFlow"
},
"relationships": {"customer_id": {"id": "e2c3926e-801d-4cc2-ac3b-14d70a8de3bf",
"link": "https://demo.subscriptionflow.com/api/v1/customers/e2c3926e-801d-4cc2-ac3b-14d70a8de3bf"
},
"subscription_id": {"id": "d38fc9ee-56d2-4cfc-a133-20f92bee24da",
"link": "https://demo.subscriptionflow.com/api/v1/subscriptions/d38fc9ee-56d2-4cfc-a133-20f92bee24da"
},
"charge_id": null,
"assigned_to": null
},
"links": {"self": "https://demo.subscriptionflow.com/api/v1/usages/be86ee97-90b7-4f4d-a4d5-b79741f1b3a6",
"app_url": "https://demo.subscriptionflow.com/usage-detail/be86ee97-90b7-4f4d-a4d5-b79741f1b3a6"
}
}
}

Get with-relations list of Usages

Returns list of Usages with all foreign keys

Responses

Response Schema: application/json

id	any <varchar> (Id) A unique and immutable identifier for the usage.
name	any <varchar> (Name) The name associated with this usage. This is the name of the usage item. For example, "Data Usage".
customer_id	any <varchar> (Customer) Identifier of the customer with whom this usage is associated.
subscription_id	any <varchar> (Subscription) Identifier of the subscription with which this usage is associated.
charge_id	any <varchar> (Charge) Identifier of the charge with which this usage is associated.
status	any <varchar> (Status) The current state of the usage (e.g., processed)
quantity	any <double> (Quantity) The quantity of the usage.
start_date	any <date> (Start Date) The date when the usage starts.
end_date	any <date> (End Date) The date when the usage ends.
description	any <text> (Description) The description of the usage.
created_at	any <datetime> (Created At) The date and time when the usage was created.
assigned_to	any <char> (Assigned To) The identifier of the user to whom the usage is assigned.
data_source	any <char> (Data Source) The source of data for the usage.

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"name": "Data Usage",
"customer_id": "__test__sf5sukSOXdulGOV",
"subscription_id": "__test__sf5sukSOXdulGOV",
"charge_id": "__test__sf5sukSOXdulGOV",
"status": "processed",
"quantity": 100,
"start_date": "2023-11-01",
"end_date": "2023-11-30",
"description": "Data Usage",
"created_at": "2023-10-15T14:30:00Z",
"assigned_to": "user789",
"data_source": "System"
}

Get related list of Usages

Returns one-to-many list of Usages with related Module

path Parameters

usage_id required	string The unique identifier of usage
related required	varchar hasMany relation name

Responses

Response Schema: application/json

id	any <varchar> (Id) A unique and immutable identifier for the usage.
name	any <varchar> (Name) The name associated with this usage. This is the name of the usage item. For example, "Data Usage".
customer_id	any <varchar> (Customer) Identifier of the customer with whom this usage is associated.
subscription_id	any <varchar> (Subscription) Identifier of the subscription with which this usage is associated.
charge_id	any <varchar> (Charge) Identifier of the charge with which this usage is associated.
status	any <varchar> (Status) The current state of the usage (e.g., processed)
quantity	any <double> (Quantity) The quantity of the usage.
start_date	any <date> (Start Date) The date when the usage starts.
end_date	any <date> (End Date) The date when the usage ends.
description	any <text> (Description) The description of the usage.
created_at	any <datetime> (Created At) The date and time when the usage was created.
assigned_to	any <char> (Assigned To) The identifier of the user to whom the usage is assigned.
data_source	any <char> (Data Source) The source of data for the usage.

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"name": "Data Usage",
"customer_id": "__test__sf5sukSOXdulGOV",
"subscription_id": "__test__sf5sukSOXdulGOV",
"charge_id": "__test__sf5sukSOXdulGOV",
"status": "processed",
"quantity": 100,
"start_date": "2023-11-01",
"end_date": "2023-11-30",
"description": "Data Usage",
"created_at": "2023-10-15T14:30:00Z",
"assigned_to": "user789",
"data_source": "System"
}

Get filtered list of Usages

Search for usage records based on specific criteria or filters. Use this endpoint to find usages that match given parameters, such as date range or type.

path Parameters

fieldName

required

varchar

Field name to apply filter E.g. 'name' = 'John'

Responses

Response Schema: application/json

id	any <varchar> (Id) A unique and immutable identifier for the usage.
name	any <varchar> (Name) The name associated with this usage. This is the name of the usage item. For example, "Data Usage".
customer_id	any <varchar> (Customer) Identifier of the customer with whom this usage is associated.
subscription_id	any <varchar> (Subscription) Identifier of the subscription with which this usage is associated.
charge_id	any <varchar> (Charge) Identifier of the charge with which this usage is associated.
status	any <varchar> (Status) The current state of the usage (e.g., processed)
quantity	any <double> (Quantity) The quantity of the usage.
start_date	any <date> (Start Date) The date when the usage starts.
end_date	any <date> (End Date) The date when the usage ends.
description	any <text> (Description) The description of the usage.
created_at	any <datetime> (Created At) The date and time when the usage was created.
assigned_to	any <char> (Assigned To) The identifier of the user to whom the usage is assigned.
data_source	any <char> (Data Source) The source of data for the usage.

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"name": "Data Usage",
"customer_id": "__test__sf5sukSOXdulGOV",
"subscription_id": "__test__sf5sukSOXdulGOV",
"charge_id": "__test__sf5sukSOXdulGOV",
"status": "processed",
"quantity": 100,
"start_date": "2023-11-01",
"end_date": "2023-11-30",
"description": "Data Usage",
"created_at": "2023-10-15T14:30:00Z",
"assigned_to": "user789",
"data_source": "System"
}

Filter Usage with nested conditions

Returns filtered Usage data

query Parameters

$equals	varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value'
$not_equals	varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value'
$starts	varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value'
$ends	varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value'
$contains	varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value'
$in	varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second']
$is_null	varchar Match if field have null value. E.g. filter[column_name][$is_null] = true
$not_null	varchar Match if field is not null. E.g. filter[column_name][$not_null] = true
$not_in	varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second']
$lt	varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value'
$lte	varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value'
$gt	varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value'
$gte	varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value'
$sortorder	varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc\|desc'
$limit	varchar Limit results E.g. filter[$limit] = '50' \| For offset: filter[$offset] = '20'
$paginate	varchar Paginate results E.g. filter[$paginate] = '50

Responses

Response samples

Content type

application/json

{"data": [{"id": "268ec9f4-fb4f-4870-98b9-e85d642468a4",
"name": "US-6",
"customer_id": "535fd665-5ca2-4078-96ca-f6377f26bef0",
"subscription_id": "4197b3ba-2d30-46ad-96b5-9f586c8e2ddc",
"charge_id": "95378ef0-9a20-4635-8dec-7f6703fe4141",
"status": "Processed",
"quantity": 150,
"start_date": "2022-10-07",
"end_date": "2022-10-10",
"description": null,
"created_at": "2022-11-03T12:56:00+00:00",
"assigned_to": null,
"data_source": "SubscriptionFlow"
}
]
}

Bulk destroy Usages

Returns deleted Usages data

query Parameters

ids

required

varchar

Array of ids to be deleted.

Responses

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"name": "Data Usage",
"customer_id": "__test__sf5sukSOXdulGOV",
"subscription_id": "__test__sf5sukSOXdulGOV",
"charge_id": "__test__sf5sukSOXdulGOV",
"status": "processed",
"quantity": 100,
"start_date": "2023-11-01",
"end_date": "2023-11-30",
"description": "Data Usage",
"created_at": "2023-10-15T14:30:00Z",
"assigned_to": "user789",
"data_source": "System"
}

Invoices

An invoice is a document that itemizes a customer's charges for products and services. It is generated at the end of a billing cycle, which can be monthly, quarterly, or yearly. The invoice details include the invoice ID, name, customer ID, invoice date, due date, and total amount.

Get list of Invoices

Retrieve a comprehensive list of all invoices. This endpoint returns a summary of each invoice, including key details and statuses.

Responses

Response Schema: application/json

	Array of objects
	object
	object

Response samples

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"invoice_date": "2019-08-24",
"due_date": "2019-08-24",
"terms": "string",
"status": "string",
"discount_value": 0.1,
"tax_amount": 0.1,
"miscellaneous_charges": 0.1,
"miscellaneous_charges_breakdown": "string",
"sub_total": 0.1,
"total_amount": 0.1,
"received_payment": 0.1,
"sum_of_credit_notes": 0.1,
"additional_info": "string",
"reversed_reference": "string",
"currency": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"opening_balance": 0.1,
"closing_balance": 0.1,
"data_source": "string",
"is_oneoff": 0,
"description": "string",
"shopify_sync": "string",
"note": "string"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [ ],
"items": {"url": "http://example.com",
"label": "string",
"active": true
},
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Store a new Invoice

Create and save a new invoice in the system. Provide the necessary invoice details in the request body to successfully generate and store the invoice.

While creating subscriotion you can add as many LineItems as you want by adding their product and plan id as show in parameters.

Request Body schema: application/json

id	any <char> (Id) The unique identifier for the invoice.
name	any <varchar> (Invoice Number) The invoice number.
customer_id	any <char> (Customer) The identifier of the customer associated with the invoice.
invoice_date	any <datetime> (Invoice Date) The date when the invoice was issued.
due_date	any <datetime> (Due Date) The date when the invoice is due.
terms	any <varchar> (Terms) The terms of payment for the invoice.
status	any <varchar> (Status) The status of the invoice. Possible values: `draft` - The invoice is a draft. `due` - The invoice is due.
discount_value	any <double> (Discount Value) The discount value of the invoice.
tax_amount	any <double> (Total Tax) The total tax amount of the invoice.
total_amount	any <double> (Total Amount) The total amount of the invoice.
received_payment	any <double> (Received Payment) The total amount of payments received for the invoice.
sum_of_credit_notes	any <double> (Credit Notes) The total amount of credit notes applied to the invoice.
reversed_reference	any <varchar> (Reference of Reverse) The reference of the reverse invoice.
created_at	any <timestamp> (Created At) The date and time when the invoice was created.
updated_at	any <timestamp> (Updated At) The date and time when the invoice was last updated.
opening_balance	any <decimal> (Opening Balance) The opening balance of the invoice.
closing_balance	any <decimal> (Closing Balance) The closing balance of the invoice.
created_by	any <char> (Created By) The user who created the invoice.
updated_by	any <char> (Updated By) The user who last updated the invoice.
assigned_to	any <char> (Assigned To) The user who is assigned to the invoice.
assigned_group_id	any <char> (Assigned Group) The group that is assigned to the invoice.
data_source	any <char> (Data Source) The data source of the invoice.

Responses

Request samples

Payload

Content type

application/json

{"id": "__test__in3VnHhSBWl7eY2bl",
"name": "INV-0001",
"customer_id": "__test__cs3VnHhSBWl7eY2bl",
"invoice_date": "2020-01-01T00:00:00Z",
"due_date": "2020-01-01T00:00:00Z",
"terms": "Net 30",
"status": "due",
"discount_value": 0,
"tax_amount": 0,
"total_amount": 0,
"received_payment": 0,
"sum_of_credit_notes": 0,
"reversed_reference": "",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"opening_balance": 0,
"closing_balance": 0,
"created_by": "__test__us3VnHhSBWl7eY2bl",
"updated_by": "__test__us3VnHhSBWl7eY2bl",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Response samples

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"invoice_date": "2019-08-24",
"due_date": "2019-08-24",
"terms": "string",
"status": "string",
"discount_value": 0.1,
"tax_amount": 0.1,
"miscellaneous_charges": 0.1,
"miscellaneous_charges_breakdown": "string",
"sub_total": 0.1,
"total_amount": 0.1,
"received_payment": 0.1,
"sum_of_credit_notes": 0.1,
"additional_info": "string",
"reversed_reference": "string",
"currency": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"opening_balance": 0.1,
"closing_balance": 0.1,
"data_source": "string",
"is_oneoff": 0,
"description": "string",
"shopify_sync": "string",
"note": "string"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [ ],
"items": {"url": "http://example.com",
"label": "string",
"active": true
},
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get Invoice information

Retrieve detailed information about a specific invoice. This operation requires the invoice ID to fetch and display the invoice's data.

path Parameters

invoice_id

required

string

The unique identifier for the invoice.

Responses

Response Schema: application/json

	object
	object
	object

Response samples

Content type

application/json

{"data": {"type": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"attributes": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"invoice_date": "2019-08-24",
"due_date": "2019-08-24",
"terms": "string",
"status": "string",
"discount_value": 0.1,
"tax_amount": 0.1,
"miscellaneous_charges": 0.1,
"miscellaneous_charges_breakdown": "string",
"sub_total": 0.1,
"total_amount": 0.1,
"received_payment": 0.1,
"sum_of_credit_notes": 0.1,
"additional_info": "string",
"reversed_reference": "string",
"currency": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"opening_balance": 0.1,
"closing_balance": 0.1,
"data_source": "string",
"is_oneoff": 0,
"description": "string",
"shopify_sync": "string",
"note": "string",
"customer": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "[email protected]",
"company": "string",
"phone_number": "string",
"po_number": "string",
"legal_entity": "string",
"currency": "string",
"billing_cycle_day": "string",
"notes": "string",
"image": "string",
"customer_number": "string",
"terms": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"portal_is_enabled": 0,
"tax_exempt": 0,
"certificate_id": "string",
"certificate_type": "string",
"issuing_jurisdiction": "string",
"entity_use_code": "string",
"description": "string",
"vat_id": "string",
"last_activity": "string",
"auto_charge": 0,
"billing_address_1": "string",
"billing_address_2": "string",
"billing_address_3": "string",
"billing_city": "string",
"billing_state": "string",
"billing_county": "string",
"billing_postal_code": "string",
"billing_country": "string",
"billing_name": "string",
"billing_email": "string",
"shipping_address_1": "string",
"shipping_address_2": "string",
"shipping_address_3": "string",
"shipping_city": "string",
"shipping_state": "string",
"shipping_county": "string",
"shipping_postal_code": "string",
"shipping_country": "string",
"shipping_name": "string",
"shipping_email": "string",
"data_source": "string",
"primary_churn_score_value": "string",
"primary_churn_score_grade": "string",
"miscellaneous_charges_exempt": "string",
"invoice_payer": "string",
"consolidate_invoices": "string"
},
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
"coupon_id": "string",
"plan_name": "string",
"plan_description": "string",
"product_name": "string",
"product_description": "string",
"product_sku": "string",
"charges": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"plan_price_id": "c24bf34c-545a-4bea-b228-010988bbd8b0",
"quantity": "string",
"service_from": "2019-08-24",
"service_to": "2019-08-24",
"discount": 0.1,
"tax": 0.1,
"tax_breakdown": [{ }
],
"sub_total": 0.1,
"reversed_charges": 0.1,
"reversed_reference": "string",
"accounting_account_code": "string",
"total_amount": "string",
"order_plan_id": "54c3b681-b3ea-49d2-83d0-2e18525a4271",
"name": "string",
"plan_price": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
"name": "string",
"description": "string",
"category": "string",
"charge_model": "string",
"list_price": {"USD": "string"
},
"list_price_base": "string",
"uom": "string",
"included_units": "string",
"default_quantity": "string",
"trigger_condition": "string",
"end_date": "string",
"billing_timming": 0,
"billing_period_alignment": "string",
"usage_records_rating_option": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"updated_by": "string",
"taxable": "string",
"tax_mode": "string",
"tax_id": "string",
"assigned_to": "string",
"billing_period_id": "string",
"billing_period_months_weeks": "string",
"billing_month_id": "string",
"billing_day_type_id": "string",
"billing_week_day_id": "string",
"deleted_at": "string",
"accounting_account_code": "string",
"data_source": "string",
"billing_year_month_id": "string",
"cost_price": "string",
"additional_field": "string",
"second_additional_field": "string"
}
}
]
}
],
"transactions": [{ }
]
}
},
"relationships": {"customer_id": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"link": "http://example.com"
},
"created_by": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"link": "http://example.com"
},
"updated_by": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"link": "http://example.com"
},
"assigned_to": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"link": "http://example.com"
},
"assigned_group_id": "string"
},
"links": {"self": "http://example.com",
"app_url": "http://example.com",
"checkout": "http://example.com"
}
}

Update existing Invoice

Modify the details of an existing invoice. Provide the invoice ID and updated information in the request body to apply changes.

path Parameters

invoice_id

required

string

The unique identifier for the invoice.

Request Body schema: application/json

id	any <char> (Id) The unique identifier for the invoice.
name	any <varchar> (Invoice Number) The invoice number.
customer_id	any <char> (Customer) The identifier of the customer associated with the invoice.
invoice_date	any <datetime> (Invoice Date) The date when the invoice was issued.
due_date	any <datetime> (Due Date) The date when the invoice is due.
terms	any <varchar> (Terms) The terms of payment for the invoice.
status	any <varchar> (Status) The status of the invoice. Possible values: `draft` - The invoice is a draft. `due` - The invoice is due.
discount_value	any <double> (Discount Value) The discount value of the invoice.
tax_amount	any <double> (Total Tax) The total tax amount of the invoice.
total_amount	any <double> (Total Amount) The total amount of the invoice.
received_payment	any <double> (Received Payment) The total amount of payments received for the invoice.
sum_of_credit_notes	any <double> (Credit Notes) The total amount of credit notes applied to the invoice.
reversed_reference	any <varchar> (Reference of Reverse) The reference of the reverse invoice.
created_at	any <timestamp> (Created At) The date and time when the invoice was created.
updated_at	any <timestamp> (Updated At) The date and time when the invoice was last updated.
opening_balance	any <decimal> (Opening Balance) The opening balance of the invoice.
closing_balance	any <decimal> (Closing Balance) The closing balance of the invoice.
created_by	any <char> (Created By) The user who created the invoice.
updated_by	any <char> (Updated By) The user who last updated the invoice.
assigned_to	any <char> (Assigned To) The user who is assigned to the invoice.
assigned_group_id	any <char> (Assigned Group) The group that is assigned to the invoice.
data_source	any <char> (Data Source) The data source of the invoice.

Responses

Response Schema: application/json

	object
	object
	object

Request samples

Payload

Content type

application/json

{"id": "__test__in3VnHhSBWl7eY2bl",
"name": "INV-0001",
"customer_id": "__test__cs3VnHhSBWl7eY2bl",
"invoice_date": "2020-01-01T00:00:00Z",
"due_date": "2020-01-01T00:00:00Z",
"terms": "Net 30",
"status": "due",
"discount_value": 0,
"tax_amount": 0,
"total_amount": 0,
"received_payment": 0,
"sum_of_credit_notes": 0,
"reversed_reference": "",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"opening_balance": 0,
"closing_balance": 0,
"created_by": "__test__us3VnHhSBWl7eY2bl",
"updated_by": "__test__us3VnHhSBWl7eY2bl",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Response samples

Content type

application/json

{"data": {"type": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"attributes": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"invoice_date": "2019-08-24",
"due_date": "2019-08-24",
"terms": "string",
"status": "string",
"discount_value": 0.1,
"tax_amount": 0.1,
"miscellaneous_charges": 0.1,
"miscellaneous_charges_breakdown": "string",
"sub_total": 0.1,
"total_amount": 0.1,
"received_payment": 0.1,
"sum_of_credit_notes": 0.1,
"additional_info": "string",
"reversed_reference": "string",
"currency": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"opening_balance": 0.1,
"closing_balance": 0.1,
"data_source": "string",
"is_oneoff": 0,
"description": "string",
"shopify_sync": "string",
"note": "string",
"customer": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "[email protected]",
"company": "string",
"phone_number": "string",
"po_number": "string",
"legal_entity": "string",
"currency": "string",
"billing_cycle_day": "string",
"notes": "string",
"image": "string",
"customer_number": "string",
"terms": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"portal_is_enabled": 0,
"tax_exempt": 0,
"certificate_id": "string",
"certificate_type": "string",
"issuing_jurisdiction": "string",
"entity_use_code": "string",
"description": "string",
"vat_id": "string",
"last_activity": "string",
"auto_charge": 0,
"billing_address_1": "string",
"billing_address_2": "string",
"billing_address_3": "string",
"billing_city": "string",
"billing_state": "string",
"billing_county": "string",
"billing_postal_code": "string",
"billing_country": "string",
"billing_name": "string",
"billing_email": "string",
"shipping_address_1": "string",
"shipping_address_2": "string",
"shipping_address_3": "string",
"shipping_city": "string",
"shipping_state": "string",
"shipping_county": "string",
"shipping_postal_code": "string",
"shipping_country": "string",
"shipping_name": "string",
"shipping_email": "string",
"data_source": "string",
"primary_churn_score_value": "string",
"primary_churn_score_grade": "string",
"miscellaneous_charges_exempt": "string",
"invoice_payer": "string",
"consolidate_invoices": "string"
},
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
"coupon_id": "string",
"plan_name": "string",
"plan_description": "string",
"product_name": "string",
"product_description": "string",
"product_sku": "string",
"charges": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"plan_price_id": "c24bf34c-545a-4bea-b228-010988bbd8b0",
"quantity": "string",
"service_from": "2019-08-24",
"service_to": "2019-08-24",
"discount": 0.1,
"tax": 0.1,
"tax_breakdown": [{ }
],
"sub_total": 0.1,
"reversed_charges": 0.1,
"reversed_reference": "string",
"accounting_account_code": "string",
"total_amount": "string",
"order_plan_id": "54c3b681-b3ea-49d2-83d0-2e18525a4271",
"name": "string",
"plan_price": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
"name": "string",
"description": "string",
"category": "string",
"charge_model": "string",
"list_price": {"USD": "string"
},
"list_price_base": "string",
"uom": "string",
"included_units": "string",
"default_quantity": "string",
"trigger_condition": "string",
"end_date": "string",
"billing_timming": 0,
"billing_period_alignment": "string",
"usage_records_rating_option": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"updated_by": "string",
"taxable": "string",
"tax_mode": "string",
"tax_id": "string",
"assigned_to": "string",
"billing_period_id": "string",
"billing_period_months_weeks": "string",
"billing_month_id": "string",
"billing_day_type_id": "string",
"billing_week_day_id": "string",
"deleted_at": "string",
"accounting_account_code": "string",
"data_source": "string",
"billing_year_month_id": "string",
"cost_price": "string",
"additional_field": "string",
"second_additional_field": "string"
}
}
]
}
],
"transactions": [{ }
]
}
},
"relationships": {"customer_id": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"link": "http://example.com"
},
"created_by": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"link": "http://example.com"
},
"updated_by": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"link": "http://example.com"
},
"assigned_to": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"link": "http://example.com"
},
"assigned_group_id": "string"
},
"links": {"self": "http://example.com",
"app_url": "http://example.com",
"checkout": "http://example.com"
}
}

Delete existing Invoice

Permanently remove a specific invoice from the system. This operation requires the invoice ID to identify and delete the invoice.

path Parameters

invoice_id

required

string

The unique identifier for the invoice.

Responses

Response samples

Content type

application/json

{"data": {"type": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"attributes": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"invoice_date": "2019-08-24",
"due_date": "2019-08-24",
"terms": "string",
"status": "string",
"discount_value": 0.1,
"tax_amount": 0.1,
"miscellaneous_charges": 0.1,
"miscellaneous_charges_breakdown": "string",
"sub_total": 0.1,
"total_amount": 0.1,
"received_payment": 0.1,
"sum_of_credit_notes": 0.1,
"additional_info": "string",
"reversed_reference": "string",
"currency": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"opening_balance": 0.1,
"closing_balance": 0.1,
"data_source": "string",
"is_oneoff": 0,
"description": "string",
"shopify_sync": "string",
"note": "string",
"customer": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"email": "[email protected]",
"company": "string",
"phone_number": "string",
"po_number": "string",
"legal_entity": "string",
"currency": "string",
"billing_cycle_day": "string",
"notes": "string",
"image": "string",
"customer_number": "string",
"terms": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"portal_is_enabled": 0,
"tax_exempt": 0,
"certificate_id": "string",
"certificate_type": "string",
"issuing_jurisdiction": "string",
"entity_use_code": "string",
"description": "string",
"vat_id": "string",
"last_activity": "string",
"auto_charge": 0,
"billing_address_1": "string",
"billing_address_2": "string",
"billing_address_3": "string",
"billing_city": "string",
"billing_state": "string",
"billing_county": "string",
"billing_postal_code": "string",
"billing_country": "string",
"billing_name": "string",
"billing_email": "string",
"shipping_address_1": "string",
"shipping_address_2": "string",
"shipping_address_3": "string",
"shipping_city": "string",
"shipping_state": "string",
"shipping_county": "string",
"shipping_postal_code": "string",
"shipping_country": "string",
"shipping_name": "string",
"shipping_email": "string",
"data_source": "string",
"primary_churn_score_value": "string",
"primary_churn_score_grade": "string",
"miscellaneous_charges_exempt": "string",
"invoice_payer": "string",
"consolidate_invoices": "string"
},
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
"coupon_id": "string",
"plan_name": "string",
"plan_description": "string",
"product_name": "string",
"product_description": "string",
"product_sku": "string",
"charges": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"plan_price_id": "c24bf34c-545a-4bea-b228-010988bbd8b0",
"quantity": "string",
"service_from": "2019-08-24",
"service_to": "2019-08-24",
"discount": 0.1,
"tax": 0.1,
"tax_breakdown": [{ }
],
"sub_total": 0.1,
"reversed_charges": 0.1,
"reversed_reference": "string",
"accounting_account_code": "string",
"total_amount": "string",
"order_plan_id": "54c3b681-b3ea-49d2-83d0-2e18525a4271",
"name": "string",
"plan_price": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
"name": "string",
"description": "string",
"category": "string",
"charge_model": "string",
"list_price": {"USD": "string"
},
"list_price_base": "string",
"uom": "string",
"included_units": "string",
"default_quantity": "string",
"trigger_condition": "string",
"end_date": "string",
"billing_timming": 0,
"billing_period_alignment": "string",
"usage_records_rating_option": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"updated_by": "string",
"taxable": "string",
"tax_mode": "string",
"tax_id": "string",
"assigned_to": "string",
"billing_period_id": "string",
"billing_period_months_weeks": "string",
"billing_month_id": "string",
"billing_day_type_id": "string",
"billing_week_day_id": "string",
"deleted_at": "string",
"accounting_account_code": "string",
"data_source": "string",
"billing_year_month_id": "string",
"cost_price": "string",
"additional_field": "string",
"second_additional_field": "string"
}
}
]
}
],
"transactions": [{ }
]
}
},
"relationships": {"customer_id": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"link": "http://example.com"
},
"created_by": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"link": "http://example.com"
},
"updated_by": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"link": "http://example.com"
},
"assigned_to": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"link": "http://example.com"
},
"assigned_group_id": "string"
},
"links": {"self": "http://example.com",
"app_url": "http://example.com",
"checkout": "http://example.com"
}
}

Get with-relations list of Invoices

Returns list of Invoices with all foreign keys

Responses

Response Schema: application/json

id	any <char> (Id) The unique identifier for the invoice.
name	any <varchar> (Invoice Number) The invoice number.
customer_id	any <char> (Customer) The identifier of the customer associated with the invoice.
invoice_date	any <datetime> (Invoice Date) The date when the invoice was issued.
due_date	any <datetime> (Due Date) The date when the invoice is due.
terms	any <varchar> (Terms) The terms of payment for the invoice.
status	any <varchar> (Status) The status of the invoice. Possible values: `draft` - The invoice is a draft. `due` - The invoice is due.
discount_value	any <double> (Discount Value) The discount value of the invoice.
tax_amount	any <double> (Total Tax) The total tax amount of the invoice.
total_amount	any <double> (Total Amount) The total amount of the invoice.
received_payment	any <double> (Received Payment) The total amount of payments received for the invoice.
sum_of_credit_notes	any <double> (Credit Notes) The total amount of credit notes applied to the invoice.
reversed_reference	any <varchar> (Reference of Reverse) The reference of the reverse invoice.
created_at	any <timestamp> (Created At) The date and time when the invoice was created.
updated_at	any <timestamp> (Updated At) The date and time when the invoice was last updated.
opening_balance	any <decimal> (Opening Balance) The opening balance of the invoice.
closing_balance	any <decimal> (Closing Balance) The closing balance of the invoice.
created_by	any <char> (Created By) The user who created the invoice.
updated_by	any <char> (Updated By) The user who last updated the invoice.
assigned_to	any <char> (Assigned To) The user who is assigned to the invoice.
assigned_group_id	any <char> (Assigned Group) The group that is assigned to the invoice.
data_source	any <char> (Data Source) The data source of the invoice.

Response samples

Content type

application/json

{"id": "__test__in3VnHhSBWl7eY2bl",
"name": "INV-0001",
"customer_id": "__test__cs3VnHhSBWl7eY2bl",
"invoice_date": "2020-01-01T00:00:00Z",
"due_date": "2020-01-01T00:00:00Z",
"terms": "Net 30",
"status": "due",
"discount_value": 0,
"tax_amount": 0,
"total_amount": 0,
"received_payment": 0,
"sum_of_credit_notes": 0,
"reversed_reference": "",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"opening_balance": 0,
"closing_balance": 0,
"created_by": "__test__us3VnHhSBWl7eY2bl",
"updated_by": "__test__us3VnHhSBWl7eY2bl",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Get related list of Invoices

Returns one-to-many list of Invoices with related Module

path Parameters

invoice_id required	string The unique identifier for the invoice.
related required	varchar hasMany relation name

Responses

Response Schema: application/json

Array of objects

Response samples

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"pivot_amount": 0.1,
"name": "string",
"date": "2019-08-24T14:15:22Z",
"status": "string",
"amount": 0.1,
"miscellaneous_charges": 0.1,
"miscellaneous_charges_breakdown": "string",
"unapplied_amount": 0.1,
"balance": 0.1,
"number": "string",
"api_response": "string",
"payment_type_id": "string",
"payment_method_id": "ec18d2d7-d2e0-41e4-98e4-847f14422d8a",
"cash_or_card": "string",
"customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
"type": "string",
"transaction_category": "string",
"reference": "string",
"description": "string",
"transaction_id": "string",
"reference_transaction_id": "string",
"decline_reason": "string",
"currency": "string",
"accounting_account_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"assigned_to": "b9f52997-ff03-4166-bbff-22fd35e12939",
"assigned_group_id": "string",
"data_source": "string",
"reason_code": "string",
"mv_early_renewal": 0,
"mv_renewal_plan": "string",
"approval_link": "string"
}
]
}

Get filtered list of Invoices

Search for invoices based on specific criteria or filters. Use this endpoint to locate invoices that match given parameters, such as date range or status.

path Parameters

fieldName

required

varchar

Field name to apply filter E.g. 'name' = 'John'

Responses

Response Schema: application/json

id	any <char> (Id) The unique identifier for the invoice.
name	any <varchar> (Invoice Number) The invoice number.
customer_id	any <char> (Customer) The identifier of the customer associated with the invoice.
invoice_date	any <datetime> (Invoice Date) The date when the invoice was issued.
due_date	any <datetime> (Due Date) The date when the invoice is due.
terms	any <varchar> (Terms) The terms of payment for the invoice.
status	any <varchar> (Status) The status of the invoice. Possible values: `draft` - The invoice is a draft. `due` - The invoice is due.
discount_value	any <double> (Discount Value) The discount value of the invoice.
tax_amount	any <double> (Total Tax) The total tax amount of the invoice.
total_amount	any <double> (Total Amount) The total amount of the invoice.
received_payment	any <double> (Received Payment) The total amount of payments received for the invoice.
sum_of_credit_notes	any <double> (Credit Notes) The total amount of credit notes applied to the invoice.
reversed_reference	any <varchar> (Reference of Reverse) The reference of the reverse invoice.
created_at	any <timestamp> (Created At) The date and time when the invoice was created.
updated_at	any <timestamp> (Updated At) The date and time when the invoice was last updated.
opening_balance	any <decimal> (Opening Balance) The opening balance of the invoice.
closing_balance	any <decimal> (Closing Balance) The closing balance of the invoice.
created_by	any <char> (Created By) The user who created the invoice.
updated_by	any <char> (Updated By) The user who last updated the invoice.
assigned_to	any <char> (Assigned To) The user who is assigned to the invoice.
assigned_group_id	any <char> (Assigned Group) The group that is assigned to the invoice.
data_source	any <char> (Data Source) The data source of the invoice.

Response samples

Content type

application/json

{"id": "__test__in3VnHhSBWl7eY2bl",
"name": "INV-0001",
"customer_id": "__test__cs3VnHhSBWl7eY2bl",
"invoice_date": "2020-01-01T00:00:00Z",
"due_date": "2020-01-01T00:00:00Z",
"terms": "Net 30",
"status": "due",
"discount_value": 0,
"tax_amount": 0,
"total_amount": 0,
"received_payment": 0,
"sum_of_credit_notes": 0,
"reversed_reference": "",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"opening_balance": 0,
"closing_balance": 0,
"created_by": "__test__us3VnHhSBWl7eY2bl",
"updated_by": "__test__us3VnHhSBWl7eY2bl",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Filter Invoice with nested conditions

Returns filtered Invoice data

query Parameters

$equals	varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value'
$not_equals	varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value'
$starts	varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value'
$ends	varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value'
$contains	varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value'
$in	varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second']
$is_null	varchar Match if field have null value. E.g. filter[column_name][$is_null] = true
$not_null	varchar Match if field is not null. E.g. filter[column_name][$not_null] = true
$not_in	varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second']
$lt	varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value'
$lte	varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value'
$gt	varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value'
$gte	varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value'
$sortorder	varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc\|desc'
$limit	varchar Limit results E.g. filter[$limit] = '50' \| For offset: filter[$offset] = '20'
$paginate	varchar Paginate results E.g. filter[$paginate] = '50

Responses

Response samples

Content type

application/json

{"id": "__test__in3VnHhSBWl7eY2bl",
"name": "INV-0001",
"customer_id": "__test__cs3VnHhSBWl7eY2bl",
"invoice_date": "2020-01-01T00:00:00Z",
"due_date": "2020-01-01T00:00:00Z",
"terms": "Net 30",
"status": "due",
"discount_value": 0,
"tax_amount": 0,
"total_amount": 0,
"received_payment": 0,
"sum_of_credit_notes": 0,
"reversed_reference": "",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"opening_balance": 0,
"closing_balance": 0,
"created_by": "__test__us3VnHhSBWl7eY2bl",
"updated_by": "__test__us3VnHhSBWl7eY2bl",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Bulk destroy Invoices

Returns deleted Invoices data

query Parameters

ids

required

varchar

Array of ids to be deleted.

Responses

Response samples

Content type

application/json

{"id": "__test__in3VnHhSBWl7eY2bl",
"name": "INV-0001",
"customer_id": "__test__cs3VnHhSBWl7eY2bl",
"invoice_date": "2020-01-01T00:00:00Z",
"due_date": "2020-01-01T00:00:00Z",
"terms": "Net 30",
"status": "due",
"discount_value": 0,
"tax_amount": 0,
"total_amount": 0,
"received_payment": 0,
"sum_of_credit_notes": 0,
"reversed_reference": "",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"opening_balance": 0,
"closing_balance": 0,
"created_by": "__test__us3VnHhSBWl7eY2bl",
"updated_by": "__test__us3VnHhSBWl7eY2bl",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Transactions

A transaction is a record of a payment that has been processed for a customer. The transaction details include the transaction ID, name, customer ID, transaction date, status, amount, and payment method.

The transaction status can be one of the following:

Paid: The transaction is paid.
Failed: The transaction failed.
Pending: The transaction is pending.
Declined: The transaction is declined.
Processing: The transaction is processing.

Get list of Transactions

Retrieve a comprehensive list of all transactions. This endpoint returns a summary of each transaction, including key details and statuses.

Responses

Response Schema: application/json

id	any <varchar> (Id) A unique and immutable identifier for the transaction.
name	any <varchar> (Name) The name associated with this transaction.
date	any <date> (Date) The date when the transaction was created.
status	any <varchar> (Status) The status of the transaction. Possible values are `success` - The transaction was successful. `pending` - The transaction is pending. `failed` - The transaction failed.
amount	any <double> (Amount) The amount of the transaction.
unapplied_amount	any <double> (Unapplied Amount) The unapplied amount of the transaction.
balance	any <double> (Balance) The balance of the transaction.
number	any <varchar> (Transaction ID) The unique identifier of the transaction.
api_response	any <varchar> (API Response) The API response of the transaction.
payment_type_id	any <varchar> (Payment Method) The identifier of the payment method associated with the transaction.
payment_method_id	any <varchar> (Payment Method ID) The identifier of the payment method associated with the transaction.
cash_or_card	any <varchar> (Payment Source) The payment source of the transaction. Possible values are `cash` - The transaction was paid in cash. `card` - The transaction was paid by card.
customer_id	any <varchar> (Customer) The identifier of the customer associated with the transaction.
type	any <varchar> (Type) The type of the transaction.
transaction_category	any <varchar> (Transaction Category) The category of the transaction.
reference	any <varchar> (Reference) The reference of the transaction.
description	any <text> (Description) The description of the transaction.
transaction_id	any <varchar> (Unique Transaction Number) The unique transaction number of the transaction.
reference_transaction_id	any <varchar> (Reference Transaction Id) The identifier of the reference transaction.
decline_reason	any <text> (Declined Reason) The reason for the transaction decline.
accounting_account_code	any <varchar> (Account Code) The accounting account code of the transaction.
created_at	any <timestamp> (Created At) The date and time when the transaction was created.
assigned_to	any <char> (Assigned To) The identifier of the user to whom the transaction is assigned.
assigned_group_id	any <char> (Assigned Group) The identifier of the group to which the transaction is assigned.
data_source	any <char> (Data Source) The source of data for the transaction.

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"name": "Premium Subscription",
"date": "2023-11-01",
"status": "success",
"amount": 100,
"unapplied_amount": 0,
"balance": 0,
"number": "__test__sf5sukSOXduqmOY",
"api_response": "",
"payment_type_id": "__test__sf5sukSOXduqmOY",
"payment_method_id": "__test__sf5sukSOXduqmOY",
"cash_or_card": "card",
"customer_id": "__test__sf5sukSOXduqmOY",
"type": "payment",
"transaction_category": "payment",
"reference": "",
"description": "Payment for subscription",
"transaction_id": "__test__sf5sukSOXduqmOY",
"reference_transaction_id": "__test__sf5sukSOXduqmOY",
"decline_reason": "",
"accounting_account_code": "",
"created_at": "2023-10-15T14:30:00Z",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System"
}

Store a new Transaction

Create and record a new transaction in the system. Provide the necessary details in the request body to successfully log the new transaction.

Request Body schema: application/json
required

id	any <varchar> (Id) A unique and immutable identifier for the transaction.
name	any <varchar> (Name) The name associated with this transaction.
date	any <date> (Date) The date when the transaction was created.
status	any <varchar> (Status) The status of the transaction. Possible values are `success` - The transaction was successful. `pending` - The transaction is pending. `failed` - The transaction failed.
amount	any <double> (Amount) The amount of the transaction.
unapplied_amount	any <double> (Unapplied Amount) The unapplied amount of the transaction.
balance	any <double> (Balance) The balance of the transaction.
number	any <varchar> (Transaction ID) The unique identifier of the transaction.
api_response	any <varchar> (API Response) The API response of the transaction.
payment_type_id	any <varchar> (Payment Method) The identifier of the payment method associated with the transaction.
payment_method_id	any <varchar> (Payment Method ID) The identifier of the payment method associated with the transaction.
cash_or_card	any <varchar> (Payment Source) The payment source of the transaction. Possible values are `cash` - The transaction was paid in cash. `card` - The transaction was paid by card.
customer_id	any <varchar> (Customer) The identifier of the customer associated with the transaction.
type	any <varchar> (Type) The type of the transaction.
transaction_category	any <varchar> (Transaction Category) The category of the transaction.
reference	any <varchar> (Reference) The reference of the transaction.
description	any <text> (Description) The description of the transaction.
transaction_id	any <varchar> (Unique Transaction Number) The unique transaction number of the transaction.
reference_transaction_id	any <varchar> (Reference Transaction Id) The identifier of the reference transaction.
decline_reason	any <text> (Declined Reason) The reason for the transaction decline.
accounting_account_code	any <varchar> (Account Code) The accounting account code of the transaction.
created_at	any <timestamp> (Created At) The date and time when the transaction was created.
assigned_to	any <char> (Assigned To) The identifier of the user to whom the transaction is assigned.
assigned_group_id	any <char> (Assigned Group) The identifier of the group to which the transaction is assigned.
data_source	any <char> (Data Source) The source of data for the transaction.

Responses

Request samples

Payload

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"name": "Premium Subscription",
"date": "2023-11-01",
"status": "success",
"amount": 100,
"unapplied_amount": 0,
"balance": 0,
"number": "__test__sf5sukSOXduqmOY",
"api_response": "",
"payment_type_id": "__test__sf5sukSOXduqmOY",
"payment_method_id": "__test__sf5sukSOXduqmOY",
"cash_or_card": "card",
"customer_id": "__test__sf5sukSOXduqmOY",
"type": "payment",
"transaction_category": "payment",
"reference": "",
"description": "Payment for subscription",
"transaction_id": "__test__sf5sukSOXduqmOY",
"reference_transaction_id": "__test__sf5sukSOXduqmOY",
"decline_reason": "",
"accounting_account_code": "",
"created_at": "2023-10-15T14:30:00Z",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System"
}

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"name": "Premium Subscription",
"date": "2023-11-01",
"status": "success",
"amount": 100,
"unapplied_amount": 0,
"balance": 0,
"number": "__test__sf5sukSOXduqmOY",
"api_response": "",
"payment_type_id": "__test__sf5sukSOXduqmOY",
"payment_method_id": "__test__sf5sukSOXduqmOY",
"cash_or_card": "card",
"customer_id": "__test__sf5sukSOXduqmOY",
"type": "payment",
"transaction_category": "payment",
"reference": "",
"description": "Payment for subscription",
"transaction_id": "__test__sf5sukSOXduqmOY",
"reference_transaction_id": "__test__sf5sukSOXduqmOY",
"decline_reason": "",
"accounting_account_code": "",
"created_at": "2023-10-15T14:30:00Z",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System"
}

Get Transaction information

Retrieve detailed information about a specific transaction. This operation requires the transaction ID to fetch and display the relevant data.

path Parameters

transaction

required

char

Transaction id

Responses

Response Schema: application/json

id	any <varchar> (Id) A unique and immutable identifier for the transaction.
name	any <varchar> (Name) The name associated with this transaction.
date	any <date> (Date) The date when the transaction was created.
status	any <varchar> (Status) The status of the transaction. Possible values are `success` - The transaction was successful. `pending` - The transaction is pending. `failed` - The transaction failed.
amount	any <double> (Amount) The amount of the transaction.
unapplied_amount	any <double> (Unapplied Amount) The unapplied amount of the transaction.
balance	any <double> (Balance) The balance of the transaction.
number	any <varchar> (Transaction ID) The unique identifier of the transaction.
api_response	any <varchar> (API Response) The API response of the transaction.
payment_type_id	any <varchar> (Payment Method) The identifier of the payment method associated with the transaction.
payment_method_id	any <varchar> (Payment Method ID) The identifier of the payment method associated with the transaction.
cash_or_card	any <varchar> (Payment Source) The payment source of the transaction. Possible values are `cash` - The transaction was paid in cash. `card` - The transaction was paid by card.
customer_id	any <varchar> (Customer) The identifier of the customer associated with the transaction.
type	any <varchar> (Type) The type of the transaction.
transaction_category	any <varchar> (Transaction Category) The category of the transaction.
reference	any <varchar> (Reference) The reference of the transaction.
description	any <text> (Description) The description of the transaction.
transaction_id	any <varchar> (Unique Transaction Number) The unique transaction number of the transaction.
reference_transaction_id	any <varchar> (Reference Transaction Id) The identifier of the reference transaction.
decline_reason	any <text> (Declined Reason) The reason for the transaction decline.
accounting_account_code	any <varchar> (Account Code) The accounting account code of the transaction.
created_at	any <timestamp> (Created At) The date and time when the transaction was created.
assigned_to	any <char> (Assigned To) The identifier of the user to whom the transaction is assigned.
assigned_group_id	any <char> (Assigned Group) The identifier of the group to which the transaction is assigned.
data_source	any <char> (Data Source) The source of data for the transaction.

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"name": "Premium Subscription",
"date": "2023-11-01",
"status": "success",
"amount": 100,
"unapplied_amount": 0,
"balance": 0,
"number": "__test__sf5sukSOXduqmOY",
"api_response": "",
"payment_type_id": "__test__sf5sukSOXduqmOY",
"payment_method_id": "__test__sf5sukSOXduqmOY",
"cash_or_card": "card",
"customer_id": "__test__sf5sukSOXduqmOY",
"type": "payment",
"transaction_category": "payment",
"reference": "",
"description": "Payment for subscription",
"transaction_id": "__test__sf5sukSOXduqmOY",
"reference_transaction_id": "__test__sf5sukSOXduqmOY",
"decline_reason": "",
"accounting_account_code": "",
"created_at": "2023-10-15T14:30:00Z",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System"
}

Update existing Transaction

Modify the details of an existing transaction. Provide the transaction ID and updated information in the request body to apply changes.

path Parameters

transaction

required

char

Transaction id

Request Body schema: application/json
required

id	any <varchar> (Id) A unique and immutable identifier for the transaction.
name	any <varchar> (Name) The name associated with this transaction.
date	any <date> (Date) The date when the transaction was created.
status	any <varchar> (Status) The status of the transaction. Possible values are `success` - The transaction was successful. `pending` - The transaction is pending. `failed` - The transaction failed.
amount	any <double> (Amount) The amount of the transaction.
unapplied_amount	any <double> (Unapplied Amount) The unapplied amount of the transaction.
balance	any <double> (Balance) The balance of the transaction.
number	any <varchar> (Transaction ID) The unique identifier of the transaction.
api_response	any <varchar> (API Response) The API response of the transaction.
payment_type_id	any <varchar> (Payment Method) The identifier of the payment method associated with the transaction.
payment_method_id	any <varchar> (Payment Method ID) The identifier of the payment method associated with the transaction.
cash_or_card	any <varchar> (Payment Source) The payment source of the transaction. Possible values are `cash` - The transaction was paid in cash. `card` - The transaction was paid by card.
customer_id	any <varchar> (Customer) The identifier of the customer associated with the transaction.
type	any <varchar> (Type) The type of the transaction.
transaction_category	any <varchar> (Transaction Category) The category of the transaction.
reference	any <varchar> (Reference) The reference of the transaction.
description	any <text> (Description) The description of the transaction.
transaction_id	any <varchar> (Unique Transaction Number) The unique transaction number of the transaction.
reference_transaction_id	any <varchar> (Reference Transaction Id) The identifier of the reference transaction.
decline_reason	any <text> (Declined Reason) The reason for the transaction decline.
accounting_account_code	any <varchar> (Account Code) The accounting account code of the transaction.
created_at	any <timestamp> (Created At) The date and time when the transaction was created.
assigned_to	any <char> (Assigned To) The identifier of the user to whom the transaction is assigned.
assigned_group_id	any <char> (Assigned Group) The identifier of the group to which the transaction is assigned.
data_source	any <char> (Data Source) The source of data for the transaction.

Responses

Response Schema: application/json

id	any <varchar> (Id) A unique and immutable identifier for the transaction.
name	any <varchar> (Name) The name associated with this transaction.
date	any <date> (Date) The date when the transaction was created.
status	any <varchar> (Status) The status of the transaction. Possible values are `success` - The transaction was successful. `pending` - The transaction is pending. `failed` - The transaction failed.
amount	any <double> (Amount) The amount of the transaction.
unapplied_amount	any <double> (Unapplied Amount) The unapplied amount of the transaction.
balance	any <double> (Balance) The balance of the transaction.
number	any <varchar> (Transaction ID) The unique identifier of the transaction.
api_response	any <varchar> (API Response) The API response of the transaction.
payment_type_id	any <varchar> (Payment Method) The identifier of the payment method associated with the transaction.
payment_method_id	any <varchar> (Payment Method ID) The identifier of the payment method associated with the transaction.
cash_or_card	any <varchar> (Payment Source) The payment source of the transaction. Possible values are `cash` - The transaction was paid in cash. `card` - The transaction was paid by card.
customer_id	any <varchar> (Customer) The identifier of the customer associated with the transaction.
type	any <varchar> (Type) The type of the transaction.
transaction_category	any <varchar> (Transaction Category) The category of the transaction.
reference	any <varchar> (Reference) The reference of the transaction.
description	any <text> (Description) The description of the transaction.
transaction_id	any <varchar> (Unique Transaction Number) The unique transaction number of the transaction.
reference_transaction_id	any <varchar> (Reference Transaction Id) The identifier of the reference transaction.
decline_reason	any <text> (Declined Reason) The reason for the transaction decline.
accounting_account_code	any <varchar> (Account Code) The accounting account code of the transaction.
created_at	any <timestamp> (Created At) The date and time when the transaction was created.
assigned_to	any <char> (Assigned To) The identifier of the user to whom the transaction is assigned.
assigned_group_id	any <char> (Assigned Group) The identifier of the group to which the transaction is assigned.
data_source	any <char> (Data Source) The source of data for the transaction.

Request samples

Payload

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"name": "Premium Subscription",
"date": "2023-11-01",
"status": "success",
"amount": 100,
"unapplied_amount": 0,
"balance": 0,
"number": "__test__sf5sukSOXduqmOY",
"api_response": "",
"payment_type_id": "__test__sf5sukSOXduqmOY",
"payment_method_id": "__test__sf5sukSOXduqmOY",
"cash_or_card": "card",
"customer_id": "__test__sf5sukSOXduqmOY",
"type": "payment",
"transaction_category": "payment",
"reference": "",
"description": "Payment for subscription",
"transaction_id": "__test__sf5sukSOXduqmOY",
"reference_transaction_id": "__test__sf5sukSOXduqmOY",
"decline_reason": "",
"accounting_account_code": "",
"created_at": "2023-10-15T14:30:00Z",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System"
}

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"name": "Premium Subscription",
"date": "2023-11-01",
"status": "success",
"amount": 100,
"unapplied_amount": 0,
"balance": 0,
"number": "__test__sf5sukSOXduqmOY",
"api_response": "",
"payment_type_id": "__test__sf5sukSOXduqmOY",
"payment_method_id": "__test__sf5sukSOXduqmOY",
"cash_or_card": "card",
"customer_id": "__test__sf5sukSOXduqmOY",
"type": "payment",
"transaction_category": "payment",
"reference": "",
"description": "Payment for subscription",
"transaction_id": "__test__sf5sukSOXduqmOY",
"reference_transaction_id": "__test__sf5sukSOXduqmOY",
"decline_reason": "",
"accounting_account_code": "",
"created_at": "2023-10-15T14:30:00Z",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System"
}

Delete existing Transaction

Permanently remove a specific transaction from the system. This operation requires the transaction ID to identify and delete the transaction record.

path Parameters

transaction

required

char

Transaction id

Responses

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"name": "Premium Subscription",
"date": "2023-11-01",
"status": "success",
"amount": 100,
"unapplied_amount": 0,
"balance": 0,
"number": "__test__sf5sukSOXduqmOY",
"api_response": "",
"payment_type_id": "__test__sf5sukSOXduqmOY",
"payment_method_id": "__test__sf5sukSOXduqmOY",
"cash_or_card": "card",
"customer_id": "__test__sf5sukSOXduqmOY",
"type": "payment",
"transaction_category": "payment",
"reference": "",
"description": "Payment for subscription",
"transaction_id": "__test__sf5sukSOXduqmOY",
"reference_transaction_id": "__test__sf5sukSOXduqmOY",
"decline_reason": "",
"accounting_account_code": "",
"created_at": "2023-10-15T14:30:00Z",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System"
}

Get with-relations list of Transactions

Returns list of Transactions with all foreign keys

Responses

Response Schema: application/json

id	any <varchar> (Id) A unique and immutable identifier for the transaction.
name	any <varchar> (Name) The name associated with this transaction.
date	any <date> (Date) The date when the transaction was created.
status	any <varchar> (Status) The status of the transaction. Possible values are `success` - The transaction was successful. `pending` - The transaction is pending. `failed` - The transaction failed.
amount	any <double> (Amount) The amount of the transaction.
unapplied_amount	any <double> (Unapplied Amount) The unapplied amount of the transaction.
balance	any <double> (Balance) The balance of the transaction.
number	any <varchar> (Transaction ID) The unique identifier of the transaction.
api_response	any <varchar> (API Response) The API response of the transaction.
payment_type_id	any <varchar> (Payment Method) The identifier of the payment method associated with the transaction.
payment_method_id	any <varchar> (Payment Method ID) The identifier of the payment method associated with the transaction.
cash_or_card	any <varchar> (Payment Source) The payment source of the transaction. Possible values are `cash` - The transaction was paid in cash. `card` - The transaction was paid by card.
customer_id	any <varchar> (Customer) The identifier of the customer associated with the transaction.
type	any <varchar> (Type) The type of the transaction.
transaction_category	any <varchar> (Transaction Category) The category of the transaction.
reference	any <varchar> (Reference) The reference of the transaction.
description	any <text> (Description) The description of the transaction.
transaction_id	any <varchar> (Unique Transaction Number) The unique transaction number of the transaction.
reference_transaction_id	any <varchar> (Reference Transaction Id) The identifier of the reference transaction.
decline_reason	any <text> (Declined Reason) The reason for the transaction decline.
accounting_account_code	any <varchar> (Account Code) The accounting account code of the transaction.
created_at	any <timestamp> (Created At) The date and time when the transaction was created.
assigned_to	any <char> (Assigned To) The identifier of the user to whom the transaction is assigned.
assigned_group_id	any <char> (Assigned Group) The identifier of the group to which the transaction is assigned.
data_source	any <char> (Data Source) The source of data for the transaction.

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"name": "Premium Subscription",
"date": "2023-11-01",
"status": "success",
"amount": 100,
"unapplied_amount": 0,
"balance": 0,
"number": "__test__sf5sukSOXduqmOY",
"api_response": "",
"payment_type_id": "__test__sf5sukSOXduqmOY",
"payment_method_id": "__test__sf5sukSOXduqmOY",
"cash_or_card": "card",
"customer_id": "__test__sf5sukSOXduqmOY",
"type": "payment",
"transaction_category": "payment",
"reference": "",
"description": "Payment for subscription",
"transaction_id": "__test__sf5sukSOXduqmOY",
"reference_transaction_id": "__test__sf5sukSOXduqmOY",
"decline_reason": "",
"accounting_account_code": "",
"created_at": "2023-10-15T14:30:00Z",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System"
}

Get related list of Transactions

Returns one-to-many list of Transactions with related Module

path Parameters

id required	char Transaction id
related required	varchar hasMany relation name

Responses

Response Schema: application/json

id	any <varchar> (Id) A unique and immutable identifier for the transaction.
name	any <varchar> (Name) The name associated with this transaction.
date	any <date> (Date) The date when the transaction was created.
status	any <varchar> (Status) The status of the transaction. Possible values are `success` - The transaction was successful. `pending` - The transaction is pending. `failed` - The transaction failed.
amount	any <double> (Amount) The amount of the transaction.
unapplied_amount	any <double> (Unapplied Amount) The unapplied amount of the transaction.
balance	any <double> (Balance) The balance of the transaction.
number	any <varchar> (Transaction ID) The unique identifier of the transaction.
api_response	any <varchar> (API Response) The API response of the transaction.
payment_type_id	any <varchar> (Payment Method) The identifier of the payment method associated with the transaction.
payment_method_id	any <varchar> (Payment Method ID) The identifier of the payment method associated with the transaction.
cash_or_card	any <varchar> (Payment Source) The payment source of the transaction. Possible values are `cash` - The transaction was paid in cash. `card` - The transaction was paid by card.
customer_id	any <varchar> (Customer) The identifier of the customer associated with the transaction.
type	any <varchar> (Type) The type of the transaction.
transaction_category	any <varchar> (Transaction Category) The category of the transaction.
reference	any <varchar> (Reference) The reference of the transaction.
description	any <text> (Description) The description of the transaction.
transaction_id	any <varchar> (Unique Transaction Number) The unique transaction number of the transaction.
reference_transaction_id	any <varchar> (Reference Transaction Id) The identifier of the reference transaction.
decline_reason	any <text> (Declined Reason) The reason for the transaction decline.
accounting_account_code	any <varchar> (Account Code) The accounting account code of the transaction.
created_at	any <timestamp> (Created At) The date and time when the transaction was created.
assigned_to	any <char> (Assigned To) The identifier of the user to whom the transaction is assigned.
assigned_group_id	any <char> (Assigned Group) The identifier of the group to which the transaction is assigned.
data_source	any <char> (Data Source) The source of data for the transaction.

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"name": "Premium Subscription",
"date": "2023-11-01",
"status": "success",
"amount": 100,
"unapplied_amount": 0,
"balance": 0,
"number": "__test__sf5sukSOXduqmOY",
"api_response": "",
"payment_type_id": "__test__sf5sukSOXduqmOY",
"payment_method_id": "__test__sf5sukSOXduqmOY",
"cash_or_card": "card",
"customer_id": "__test__sf5sukSOXduqmOY",
"type": "payment",
"transaction_category": "payment",
"reference": "",
"description": "Payment for subscription",
"transaction_id": "__test__sf5sukSOXduqmOY",
"reference_transaction_id": "__test__sf5sukSOXduqmOY",
"decline_reason": "",
"accounting_account_code": "",
"created_at": "2023-10-15T14:30:00Z",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System"
}

Get filtered list of Transactions

Returns list of Transactions with quick filters

path Parameters

fieldName

required

varchar

Field name to apply filter E.g. 'name' = 'John'

Responses

Response Schema: application/json

id	any <varchar> (Id) A unique and immutable identifier for the transaction.
name	any <varchar> (Name) The name associated with this transaction.
date	any <date> (Date) The date when the transaction was created.
status	any <varchar> (Status) The status of the transaction. Possible values are `success` - The transaction was successful. `pending` - The transaction is pending. `failed` - The transaction failed.
amount	any <double> (Amount) The amount of the transaction.
unapplied_amount	any <double> (Unapplied Amount) The unapplied amount of the transaction.
balance	any <double> (Balance) The balance of the transaction.
number	any <varchar> (Transaction ID) The unique identifier of the transaction.
api_response	any <varchar> (API Response) The API response of the transaction.
payment_type_id	any <varchar> (Payment Method) The identifier of the payment method associated with the transaction.
payment_method_id	any <varchar> (Payment Method ID) The identifier of the payment method associated with the transaction.
cash_or_card	any <varchar> (Payment Source) The payment source of the transaction. Possible values are `cash` - The transaction was paid in cash. `card` - The transaction was paid by card.
customer_id	any <varchar> (Customer) The identifier of the customer associated with the transaction.
type	any <varchar> (Type) The type of the transaction.
transaction_category	any <varchar> (Transaction Category) The category of the transaction.
reference	any <varchar> (Reference) The reference of the transaction.
description	any <text> (Description) The description of the transaction.
transaction_id	any <varchar> (Unique Transaction Number) The unique transaction number of the transaction.
reference_transaction_id	any <varchar> (Reference Transaction Id) The identifier of the reference transaction.
decline_reason	any <text> (Declined Reason) The reason for the transaction decline.
accounting_account_code	any <varchar> (Account Code) The accounting account code of the transaction.
created_at	any <timestamp> (Created At) The date and time when the transaction was created.
assigned_to	any <char> (Assigned To) The identifier of the user to whom the transaction is assigned.
assigned_group_id	any <char> (Assigned Group) The identifier of the group to which the transaction is assigned.
data_source	any <char> (Data Source) The source of data for the transaction.

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"name": "Premium Subscription",
"date": "2023-11-01",
"status": "success",
"amount": 100,
"unapplied_amount": 0,
"balance": 0,
"number": "__test__sf5sukSOXduqmOY",
"api_response": "",
"payment_type_id": "__test__sf5sukSOXduqmOY",
"payment_method_id": "__test__sf5sukSOXduqmOY",
"cash_or_card": "card",
"customer_id": "__test__sf5sukSOXduqmOY",
"type": "payment",
"transaction_category": "payment",
"reference": "",
"description": "Payment for subscription",
"transaction_id": "__test__sf5sukSOXduqmOY",
"reference_transaction_id": "__test__sf5sukSOXduqmOY",
"decline_reason": "",
"accounting_account_code": "",
"created_at": "2023-10-15T14:30:00Z",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System"
}

Filter Transaction with nested conditions

Returns filtered Transaction data

query Parameters

$equals	varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value'
$not_equals	varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value'
$starts	varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value'
$ends	varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value'
$contains	varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value'
$in	varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second']
$is_null	varchar Match if field have null value. E.g. filter[column_name][$is_null] = true
$not_null	varchar Match if field is not null. E.g. filter[column_name][$not_null] = true
$not_in	varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second']
$lt	varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value'
$lte	varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value'
$gt	varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value'
$gte	varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value'
$sortorder	varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc\|desc'
$limit	varchar Limit results E.g. filter[$limit] = '50' \| For offset: filter[$offset] = '20'
$paginate	varchar Paginate results E.g. filter[$paginate] = '50

Responses

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"name": "Premium Subscription",
"date": "2023-11-01",
"status": "success",
"amount": 100,
"unapplied_amount": 0,
"balance": 0,
"number": "__test__sf5sukSOXduqmOY",
"api_response": "",
"payment_type_id": "__test__sf5sukSOXduqmOY",
"payment_method_id": "__test__sf5sukSOXduqmOY",
"cash_or_card": "card",
"customer_id": "__test__sf5sukSOXduqmOY",
"type": "payment",
"transaction_category": "payment",
"reference": "",
"description": "Payment for subscription",
"transaction_id": "__test__sf5sukSOXduqmOY",
"reference_transaction_id": "__test__sf5sukSOXduqmOY",
"decline_reason": "",
"accounting_account_code": "",
"created_at": "2023-10-15T14:30:00Z",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System"
}

Bulk destroy Transactions

Returns deleted Transactions data

query Parameters

ids

required

varchar

Array of ids to be deleted.

Responses

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"name": "Premium Subscription",
"date": "2023-11-01",
"status": "success",
"amount": 100,
"unapplied_amount": 0,
"balance": 0,
"number": "__test__sf5sukSOXduqmOY",
"api_response": "",
"payment_type_id": "__test__sf5sukSOXduqmOY",
"payment_method_id": "__test__sf5sukSOXduqmOY",
"cash_or_card": "card",
"customer_id": "__test__sf5sukSOXduqmOY",
"type": "payment",
"transaction_category": "payment",
"reference": "",
"description": "Payment for subscription",
"transaction_id": "__test__sf5sukSOXduqmOY",
"reference_transaction_id": "__test__sf5sukSOXduqmOY",
"decline_reason": "",
"accounting_account_code": "",
"created_at": "2023-10-15T14:30:00Z",
"assigned_to": "user789",
"assigned_group_id": "group123",
"data_source": "System"
}

Products

A product is a good or service that you sell to your customers. The product details include the product ID, name, type, description, SKU, effective start date, effective end date, and status. Product have line items called plan-items that define the billing details for the product.

Possible values for product type are

Base Product: A product that is sold as a standalone item.
Addon Service: A product that is sold as an add-on to a base product.
Miscellaneous Product: A product that is sold as a one-time item.

Possible values for product status are

Active: The product is active.
Inactive: The product is inactive.

Get list of Products

Retrieve a comprehensive list of all available products. This endpoint returns detailed information about each product.

Responses

Response Schema: application/json

	Array of objects
	object
	object

Response samples

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"sku": "string",
"effective_start_date": "2019-08-24T14:15:22Z",
"effective_end_date": "2019-08-24T14:15:22Z",
"type": "string",
"status": "string",
"image": "string",
"mv_short_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"data_source": "string"
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"url": "http://example.com",
"label": "string",
"active": true
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Store a new Product

Create and store a new product in the database. Provide necessary product details in the request body.

Request Body schema: application/json

id	string
name	string
description	string
sku	string
effective_start_date	string <date-time>
effective_end_date	string <date-time>
type	string
manager_id	string
status	string
image	string <uri>
created_at	string <date-time>
updated_at	string <date-time>
created_by	string
updated_by	string
assigned_to	string
data_source	string

Responses

Request samples

Payload

Content type

application/json

{"id": "__test__pr3VnHhSBWl7eY2bl",
"name": "Product 1",
"description": "Product 1 description",
"sku": "SKU-0001",
"effective_start_date": "2020-01-01T00:00:00Z",
"effective_end_date": "2020-01-01T00:00:00Z",
"type": "Base Product",
"manager_id": "__test__us3VnHhSBWl7eY2bl",
"status": "active",
"image": "https://example.com/product-image.jpg",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__us3VnHhSBWl7eY2bl",
"updated_by": "__test__us3VnHhSBWl7eY2bl",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Response samples

Content type

application/json

{"data": {"type": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"attributes": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"sku": "string",
"effective_start_date": "2019-08-24T14:15:22Z",
"effective_end_date": "2019-08-24T14:15:22Z",
"type": "string",
"status": "string",
"image": "string",
"mv_short_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"data_source": "string"
},
"relationships": {"manager_id": "string",
"created_by": {"id": "string",
"link": "http://example.com"
},
"updated_by": {"id": "string",
"link": "http://example.com"
},
"assigned_to": {"id": "string",
"link": "http://example.com"
}
},
"links": {"self": "http://example.com",
"app_url": "http://example.com"
}
}
}

Get Product information

Retrieve detailed information about a specific product. This endpoint requires the product ID to fetch the relevant data.

path Parameters

product_id

required

string

Identifier of the product.

Responses

Response Schema: application/json

object

Response samples

Content type

application/json

{"data": {"type": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"attributes": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"sku": "string",
"effective_start_date": "2019-08-24T14:15:22Z",
"effective_end_date": "2019-08-24T14:15:22Z",
"type": "string",
"status": "string",
"image": "string",
"mv_short_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"data_source": "string"
},
"relationships": {"manager_id": "string",
"created_by": {"id": "string",
"link": "http://example.com"
},
"updated_by": {"id": "string",
"link": "http://example.com"
},
"assigned_to": {"id": "string",
"link": "http://example.com"
}
},
"links": {"self": "http://example.com",
"app_url": "http://example.com"
}
}
}

Update existing Product

Modify the details of an existing product. Provide the product ID and updated information in the request body.

path Parameters

product_id

required

string

Identifier of the product.

Request Body schema: application/json
required

	Array of objects
	object
	object

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"data": [{"id": "01ff5243-4016-4284-a9e7-2d5e8df7569d",
"name": "Software Consultancy",
"description": null,
"sku": null,
"effective_start_date": null,
"effective_end_date": null,
"type": "Base Products",
"status": "Active",
"image": null,
"mv_short_code": null,
"created_at": "2024-01-15T14:10:00+00:00",
"updated_at": "2024-01-15T14:27:00+00:00",
"data_source": "SubscriptionFlow"
}
],
"links": {"first": "https://demo.subscriptionflow.com/api/v1/products?page=1",
"last": "https://demo.subscriptionflow.com/api/v1/products?page=1",
"prev": null,
"next": null
},
"meta": {"current_page": 1,
"from": 1,
"last_page": 1,
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
}
],
"path": "https://demo.subscriptionflow.com/api/v1/products",
"per_page": 200,
"to": 77,
"total": 77
}
}

Response samples

Content type

application/json

{"data": {"type": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"attributes": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"sku": "string",
"effective_start_date": "2019-08-24T14:15:22Z",
"effective_end_date": "2019-08-24T14:15:22Z",
"type": "string",
"status": "string",
"image": "string",
"mv_short_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"data_source": "string"
},
"relationships": {"manager_id": "string",
"created_by": {"id": "string",
"link": "http://example.com"
},
"updated_by": {"id": "string",
"link": "http://example.com"
},
"assigned_to": {"id": "string",
"link": "http://example.com"
}
},
"links": {"self": "http://example.com",
"app_url": "http://example.com"
}
}
}

Delete existing Product

Remove a specific product from the database. This operation requires the product ID to identify and delete the product.

path Parameters

product_id

required

string

Identifier of the product.

Responses

Response samples

Content type

application/json

{"data": {"type": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"attributes": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"sku": "string",
"effective_start_date": "2019-08-24T14:15:22Z",
"effective_end_date": "2019-08-24T14:15:22Z",
"type": "string",
"status": "string",
"image": "string",
"mv_short_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"data_source": "string"
},
"relationships": {"manager_id": "string",
"created_by": {"id": "string",
"link": "http://example.com"
},
"updated_by": {"id": "string",
"link": "http://example.com"
},
"assigned_to": {"id": "string",
"link": "http://example.com"
}
},
"links": {"self": "http://example.com",
"app_url": "http://example.com"
}
}
}

Get with-relations list of Products

Returns list of Products with all foreign keys

Responses

Response Schema: application/json

	Array of objects
	object
	object

Response samples

Content type

application/json

{"data": [{"id": "01ff5243-4016-4284-a9e7-2d5e8df7569d",
"name": "Software Consultancy",
"description": null,
"sku": null,
"effective_start_date": null,
"effective_end_date": null,
"type": "Base Products",
"status": "Active",
"image": null,
"mv_short_code": null,
"created_at": "2024-01-15T14:10:00+00:00",
"updated_at": "2024-01-15T14:27:00+00:00",
"data_source": "SubscriptionFlow"
}
],
"links": {"first": "https://demo.subscriptionflow.com/api/v1/products?page=1",
"last": "https://demo.subscriptionflow.com/api/v1/products?page=1",
"prev": null,
"next": null
},
"meta": {"current_page": 1,
"from": 1,
"last_page": 1,
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
}
],
"path": "https://demo.subscriptionflow.com/api/v1/products",
"per_page": 200,
"to": 77,
"total": 77
}
}

Get related list of Products

Returns one-to-many list of Products with related Module

path Parameters

product_id required	string Identifier of the product.
related required	varchar hasMany relation name

Responses

Response Schema: application/json

	Array of objects
	object
	object

Response samples

Content type

application/json

{"data": [{"id": "01ff5243-4016-4284-a9e7-2d5e8df7569d",
"name": "Software Consultancy",
"description": null,
"sku": null,
"effective_start_date": null,
"effective_end_date": null,
"type": "Base Products",
"status": "Active",
"image": null,
"mv_short_code": null,
"created_at": "2024-01-15T14:10:00+00:00",
"updated_at": "2024-01-15T14:27:00+00:00",
"data_source": "SubscriptionFlow"
}
],
"links": {"first": "https://demo.subscriptionflow.com/api/v1/products?page=1",
"last": "https://demo.subscriptionflow.com/api/v1/products?page=1",
"prev": null,
"next": null
},
"meta": {"current_page": 1,
"from": 1,
"last_page": 1,
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
}
],
"path": "https://demo.subscriptionflow.com/api/v1/products",
"per_page": 200,
"to": 77,
"total": 77
}
}

Get filtered list of Products

Returns list of Products with quick filters

path Parameters

fieldName

required

varchar

Field name to apply filter E.g. 'name' = 'John'

Responses

Response Schema: application/json

	Array of objects
	object
	object

Response samples

Content type

application/json

{"data": [{"id": "01ff5243-4016-4284-a9e7-2d5e8df7569d",
"name": "Software Consultancy",
"description": null,
"sku": null,
"effective_start_date": null,
"effective_end_date": null,
"type": "Base Products",
"status": "Active",
"image": null,
"mv_short_code": null,
"created_at": "2024-01-15T14:10:00+00:00",
"updated_at": "2024-01-15T14:27:00+00:00",
"data_source": "SubscriptionFlow"
}
],
"links": {"first": "https://demo.subscriptionflow.com/api/v1/products?page=1",
"last": "https://demo.subscriptionflow.com/api/v1/products?page=1",
"prev": null,
"next": null
},
"meta": {"current_page": 1,
"from": 1,
"last_page": 1,
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
}
],
"path": "https://demo.subscriptionflow.com/api/v1/products",
"per_page": 200,
"to": 77,
"total": 77
}
}

Filter Product with nested conditions

Returns filtered Product data

query Parameters

$equals	varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value'
$not_equals	varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value'
$starts	varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value'
$ends	varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value'
$contains	varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value'
$in	varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second']
$is_null	varchar Match if field have null value. E.g. filter[column_name][$is_null] = true
$not_null	varchar Match if field is not null. E.g. filter[column_name][$not_null] = true
$not_in	varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second']
$lt	varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value'
$lte	varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value'
$gt	varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value'
$gte	varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value'
$sortorder	varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc\|desc'
$limit	varchar Limit results E.g. filter[$limit] = '50' \| For offset: filter[$offset] = '20'
$paginate	varchar Paginate results E.g. filter[$paginate] = '50

Responses

Response samples

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"sku": "string",
"effective_start_date": "2019-08-24T14:15:22Z",
"effective_end_date": "2019-08-24T14:15:22Z",
"type": "string",
"manager_id": "string",
"status": "string",
"image": "string",
"mv_short_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"updated_by": "string",
"assigned_to": "string",
"data_source": "string"
}
]
}

Bulk destroy Products

Returns deleted Products data

query Parameters

ids

required

varchar

Array of ids to be deleted.

Responses

Response samples

Content type

application/json

{"data": [{"id": "01ff5243-4016-4284-a9e7-2d5e8df7569d",
"name": "Software Consultancy",
"description": null,
"sku": null,
"effective_start_date": null,
"effective_end_date": null,
"type": "Base Products",
"status": "Active",
"image": null,
"mv_short_code": null,
"created_at": "2024-01-15T14:10:00+00:00",
"updated_at": "2024-01-15T14:27:00+00:00",
"data_source": "SubscriptionFlow"
}
],
"links": {"first": "https://demo.subscriptionflow.com/api/v1/products?page=1",
"last": "https://demo.subscriptionflow.com/api/v1/products?page=1",
"prev": null,
"next": null
},
"meta": {"current_page": 1,
"from": 1,
"last_page": 1,
"links": [{"url": null,
"label": "&laquo; Previous",
"active": false
}
],
"path": "https://demo.subscriptionflow.com/api/v1/products",
"per_page": 200,
"to": 77,
"total": 77
}
}

Plans

A plan is a set of billing details for a product. The plan details include the plan ID, name, description, effective start date, effective end date, and status. Plans have line items called plan-items that define the billing details for the plan.

Possible values for plan status are

Active: The plan is active.
Inactive: The plan is inactive.

Note: A plan can be associated with multiple products.

Get list of Plans

Retrieve a list of all available plans. This endpoint returns a summary of each plan, including key details and statuses.

Responses

Response Schema: application/json

	Array of objects
	object
	object

Response samples

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"effective_start_date": "2019-08-24T14:15:22Z",
"effective_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"image": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"data_source": "string",
"is_gift": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"url": "http://example.com",
"label": "string",
"active": true
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Store a new Plan

Create and save a new plan in the system. Provide all required plan details in the request body to successfully register the new plan.

Request Body schema: application/json

id	any <char> (Id) The unique identifier for the plan.
name	any <varchar> (Name) The name of the plan.
description	any <text> (Description) The description of the plan.
effective_start_date	any <datetime> (Effective Start Date) The date when the plan becomes effective. The plan is available for purchase starting from this date.
effective_end_date	any <datetime> (Effective End Date) The date when the plan expires. The plan is no longer available for purchase starting from this date.
status	any <varchar> (Status) The status of the plan. Possible values: `active` - The plan is active. `inactive` - The plan is inactive.
created_at	any <timestamp> (Created At) The date and time when the plan was created.
updated_at	any <timestamp> (Updated At) The date and time when the plan was last updated.
created_by	any <char> (Created By) The user who created the plan.
updated_by	any <char> (Updated By) The user who last updated the plan.
assigned_to	any <char> (Assigned To) The user who is assigned to the plan.
data_source	any <char> (Data Source) The data source of the plan.
is_gift	any <tinyint> (Is Gift Plan) Indicates whether the plan is a gift plan.

Responses

Request samples

Payload

Content type

application/json

{"id": "__test__pl3VnHhSBWl7eY2bl",
"name": "Plan 1",
"description": "Plan 1 description",
"effective_start_date": "2020-01-01T00:00:00Z",
"effective_end_date": "2020-01-01T00:00:00Z",
"status": "active",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__us3VnHhSBWl7eY2bl",
"updated_by": "__test__us3VnHhSBWl7eY2bl",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl",
"is_gift": 0
}

Response samples

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"effective_start_date": "2019-08-24T14:15:22Z",
"effective_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"image": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"data_source": "string",
"is_gift": 0
}
],
"links": {"first": "http://example.com",
"last": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"links": [{"url": "http://example.com",
"label": "string",
"active": true
}
],
"path": "http://example.com",
"per_page": 0,
"to": 0,
"total": 0
}
}

Get Plan information

Retrieve detailed information about a specific plan. This operation requires the plan ID to fetch and display the plan's data.

path Parameters

plan_id

required

string

The unique identifier of plan

Responses

Response Schema: application/json

	object
	object
	object

Response samples

Content type

application/json

{"data": {"type": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"attributes": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"effective_start_date": "2019-08-24T14:15:22Z",
"effective_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"image": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"data_source": "string",
"is_gift": 0
}
},
"relationships": {"created_by": {"id": "string",
"link": "http://example.com",
"updated_by": {"id": "string",
"link": "http://example.com"
},
"assigned_to": {"id": "string",
"link": "http://example.com"
}
}
},
"links": {"self": "http://example.com",
"app_url": "http://example.com"
}
}

Update existing Plan

Modify the details of an existing plan. Provide the plan ID and updated information in the request body to apply changes.

path Parameters

plan_id

required

string

The unique identifier of plan

Request Body schema: application/json
required

id	any <char> (Id) The unique identifier for the plan.
name	any <varchar> (Name) The name of the plan.
description	any <text> (Description) The description of the plan.
effective_start_date	any <datetime> (Effective Start Date) The date when the plan becomes effective. The plan is available for purchase starting from this date.
effective_end_date	any <datetime> (Effective End Date) The date when the plan expires. The plan is no longer available for purchase starting from this date.
status	any <varchar> (Status) The status of the plan. Possible values: `active` - The plan is active. `inactive` - The plan is inactive.
created_at	any <timestamp> (Created At) The date and time when the plan was created.
updated_at	any <timestamp> (Updated At) The date and time when the plan was last updated.
created_by	any <char> (Created By) The user who created the plan.
updated_by	any <char> (Updated By) The user who last updated the plan.
assigned_to	any <char> (Assigned To) The user who is assigned to the plan.
data_source	any <char> (Data Source) The data source of the plan.
is_gift	any <tinyint> (Is Gift Plan) Indicates whether the plan is a gift plan.

Responses

Response Schema: application/json

	object
	object
	object

Request samples

Payload

Content type

application/json

{"id": "__test__pl3VnHhSBWl7eY2bl",
"name": "Plan 1",
"description": "Plan 1 description",
"effective_start_date": "2020-01-01T00:00:00Z",
"effective_end_date": "2020-01-01T00:00:00Z",
"status": "active",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__us3VnHhSBWl7eY2bl",
"updated_by": "__test__us3VnHhSBWl7eY2bl",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl",
"is_gift": 0
}

Response samples

Content type

application/json

{"data": {"type": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"attributes": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"effective_start_date": "2019-08-24T14:15:22Z",
"effective_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"image": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"data_source": "string",
"is_gift": 0
}
},
"relationships": {"created_by": {"id": "string",
"link": "http://example.com",
"updated_by": {"id": "string",
"link": "http://example.com"
},
"assigned_to": {"id": "string",
"link": "http://example.com"
}
}
},
"links": {"self": "http://example.com",
"app_url": "http://example.com"
}
}

Delete existing Plan

Permanently remove a specific plan from the system. This operation requires the plan ID to identify and delete the plan.

path Parameters

plan_id

required

string

The unique identifier of plan

Responses

Response samples

Content type

application/json

{"data": {"type": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"attributes": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"effective_start_date": "2019-08-24T14:15:22Z",
"effective_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"image": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"data_source": "string",
"is_gift": 0
}
},
"relationships": {"created_by": {"id": "string",
"link": "http://example.com",
"updated_by": {"id": "string",
"link": "http://example.com"
},
"assigned_to": {"id": "string",
"link": "http://example.com"
}
}
},
"links": {"self": "http://example.com",
"app_url": "http://example.com"
}
}

Get with-relations list of Plans

Returns list of Plans with all foreign keys

Responses

Response Schema: application/json

id	any <char> (Id) The unique identifier for the plan.
name	any <varchar> (Name) The name of the plan.
description	any <text> (Description) The description of the plan.
effective_start_date	any <datetime> (Effective Start Date) The date when the plan becomes effective. The plan is available for purchase starting from this date.
effective_end_date	any <datetime> (Effective End Date) The date when the plan expires. The plan is no longer available for purchase starting from this date.
status	any <varchar> (Status) The status of the plan. Possible values: `active` - The plan is active. `inactive` - The plan is inactive.
created_at	any <timestamp> (Created At) The date and time when the plan was created.
updated_at	any <timestamp> (Updated At) The date and time when the plan was last updated.
created_by	any <char> (Created By) The user who created the plan.
updated_by	any <char> (Updated By) The user who last updated the plan.
assigned_to	any <char> (Assigned To) The user who is assigned to the plan.
data_source	any <char> (Data Source) The data source of the plan.
is_gift	any <tinyint> (Is Gift Plan) Indicates whether the plan is a gift plan.

Response samples

Content type

application/json

{"id": "__test__pl3VnHhSBWl7eY2bl",
"name": "Plan 1",
"description": "Plan 1 description",
"effective_start_date": "2020-01-01T00:00:00Z",
"effective_end_date": "2020-01-01T00:00:00Z",
"status": "active",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__us3VnHhSBWl7eY2bl",
"updated_by": "__test__us3VnHhSBWl7eY2bl",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl",
"is_gift": 0
}

Get related list of Plans

Returns one-to-many list of Plans with related Module

path Parameters

plan_id required	string The unique identifier of plan
related required	varchar hasMany relation name

Responses

Response Schema: application/json

Array of objects

Response samples

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
"product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
"name": "string",
"description": "string",
"category": "string",
"charge_model": "string",
"accounting_account_code": "string",
"list_price": {"USD": "string"
},
"cost_price": "string",
"additional_field": "string",
"second_additional_field": "string",
"list_price_base": "string",
"uom": "string",
"included_units": "string",
"default_quantity": "string",
"trigger_condition": "string",
"end_date": "2019-08-24T14:15:22Z",
"billing_timming": 0,
"billing_period_alignment": "string",
"usage_records_rating_option": "string",
"taxable": "string",
"tax_mode": "string",
"tax_id": "string",
"billing_period_id": "05a6ed6a-04eb-421a-9ac9-9a43b3353a4d",
"billing_period_months_weeks": "string",
"billing_month_id": "string",
"billing_day_type_id": "string",
"billing_week_day_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"assigned_to": "string",
"data_source": "string"
}
]
}

Get filtered list of Plans

Search for plans based on specific criteria. Use this endpoint to find plans that match given parameters or filters.

path Parameters

fieldName

required

varchar

Field name to apply filter E.g. 'name' = 'John'

Responses

Response Schema: application/json

id	any <char> (Id) The unique identifier for the plan.
name	any <varchar> (Name) The name of the plan.
description	any <text> (Description) The description of the plan.
effective_start_date	any <datetime> (Effective Start Date) The date when the plan becomes effective. The plan is available for purchase starting from this date.
effective_end_date	any <datetime> (Effective End Date) The date when the plan expires. The plan is no longer available for purchase starting from this date.
status	any <varchar> (Status) The status of the plan. Possible values: `active` - The plan is active. `inactive` - The plan is inactive.
created_at	any <timestamp> (Created At) The date and time when the plan was created.
updated_at	any <timestamp> (Updated At) The date and time when the plan was last updated.
created_by	any <char> (Created By) The user who created the plan.
updated_by	any <char> (Updated By) The user who last updated the plan.
assigned_to	any <char> (Assigned To) The user who is assigned to the plan.
data_source	any <char> (Data Source) The data source of the plan.
is_gift	any <tinyint> (Is Gift Plan) Indicates whether the plan is a gift plan.

Response samples

Content type

application/json

{"id": "__test__pl3VnHhSBWl7eY2bl",
"name": "Plan 1",
"description": "Plan 1 description",
"effective_start_date": "2020-01-01T00:00:00Z",
"effective_end_date": "2020-01-01T00:00:00Z",
"status": "active",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__us3VnHhSBWl7eY2bl",
"updated_by": "__test__us3VnHhSBWl7eY2bl",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl",
"is_gift": 0
}

Filter Plan with nested conditions

Returns filtered Plan data

query Parameters

$equals	varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value'
$not_equals	varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value'
$starts	varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value'
$ends	varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value'
$contains	varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value'
$in	varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second']
$is_null	varchar Match if field have null value. E.g. filter[column_name][$is_null] = true
$not_null	varchar Match if field is not null. E.g. filter[column_name][$not_null] = true
$not_in	varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second']
$lt	varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value'
$lte	varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value'
$gt	varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value'
$gte	varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value'
$sortorder	varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc\|desc'
$limit	varchar Limit results E.g. filter[$limit] = '50' \| For offset: filter[$offset] = '20'
$paginate	varchar Paginate results E.g. filter[$paginate] = '50

Responses

Response samples

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"effective_start_date": "2019-08-24T14:15:22Z",
"effective_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"image": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"updated_by": "string",
"assigned_to": "string",
"data_source": "string",
"is_gift": 0
}
]
}

Bulk destroy Plans

Returns deleted Plans data

query Parameters

ids

required

varchar

Array of ids to be deleted.

Responses

Response samples

Content type

application/json

{"id": "__test__pl3VnHhSBWl7eY2bl",
"name": "Plan 1",
"description": "Plan 1 description",
"effective_start_date": "2020-01-01T00:00:00Z",
"effective_end_date": "2020-01-01T00:00:00Z",
"status": "active",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__us3VnHhSBWl7eY2bl",
"updated_by": "__test__us3VnHhSBWl7eY2bl",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl",
"is_gift": 0
}

PlanPrice

A plan-item is a line item that defines the billing details for a product or plan. The plan-item details include the plan-item ID, name, description, category, charge model, accounting account code, list price, list price base, UOM, included units, default quantity, trigger condition, end date, billing timing, billing period alignment, usage records rating option, billing period, billing period months weeks, billing month, billing day type, billing week day, and status.

Get list of PlanPrice

Returns list of PlanPrice

Responses

Response Schema: application/json

id	any <varchar> (Id) The unique identifier for the plan price.
name	any <int> (Name) The name of the plan price.
description	any <varchar> (Description) The description of the plan price.
category	any <date> (Category) The category of the plan price.
charge_model	any <varchar> (Charge Model) The charge model of the plan price. Possible values: `flat_fee` - The plan price is a flat fee. `per_unit` - The plan price is a per unit fee. `tiered` - The plan price is a tiered fee. `volume` - The plan price is a volume fee.
accounting_account_code	any <varchar> (Account) The accounting account code of the plan price.
list_price	any <array> (List Price) The list price of the plan price.
list_price_base	any <varchar> (List Price Base) The list price base of the plan price.
uom	any <varchar> (UOM) The unit of measure (UOM) of the plan price.
included_units	any <varchar> (Included Units) The included units of the plan price.
default_quantity	any <varchar> (Default Quantity) The default quantity of the plan price.
trigger_condition	any <varchar> (Trigger Condition) The trigger condition of the plan price.
end_date	any <varchar> (End Date) The end date of the plan price.
billing_timming	any <varchar> (Billing Timming) The billing timming of the plan price. Possible values: `in_advance` - The plan price is billed in advance. `in_arrears` - The plan price is billed in arrears.
billing_period_alignment	any <varchar> (Billing Period Alignment) The billing period alignment of the plan price.
usage_records_rating_option	any <varchar> (Usage Records Rating Option) The usage records rating option of the plan price.
billing_period_id	any <int> (Billing Period) The identifier of the billing period associated with the plan price.
billing_period_months_weeks	any <int> (Billing Period Months Weeks) The billing period months weeks of the plan price.
billing_month_id	any <int> (Billing Month) The identifier of the billing month associated with the plan price.
billing_day_type_id	any <int> (Billing Day) The identifier of the billing day associated with the plan price.
billing_week_day_id	any <int> (Billing Day) The identifier of the billing day associated with the plan price.
created_at	any <timestamp> (Created At) The date and time when the plan price was created.
assigned_to	any <char> (Assigned To) The user who is assigned to the plan price.
data_source	any <char> (Data Source) The data source of the plan price.

Response samples

Content type

application/json

{"id": "__test__pp3VnHhSBWl7eY2bl",
"name": 1,
"description": "Plan 1 description",
"category": "2020-01-01",
"charge_model": "flat_fee",
"accounting_account_code": "12345",
"list_price": {"USD": "100"
},
"list_price_base": "USD",
"uom": "each",
"included_units": "1",
"default_quantity": "1",
"trigger_condition": "1",
"end_date": "2020-01-01",
"billing_timming": "in_advance",
"billing_period_alignment": "1",
"usage_records_rating_option": "1",
"billing_period_id": 1,
"billing_period_months_weeks": 1,
"billing_month_id": 1,
"billing_day_type_id": 1,
"billing_week_day_id": 1,
"created_at": "2020-01-01T00:00:00Z",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Store a new PlanPrice

Returns PlanPrice data

Request Body schema: application/json
required

id	any <varchar> (Id) The unique identifier for the plan price.
plan_id	any <int> (Plan Id) The identifier of the plan associated with the plan price.
product_id	any <int> (Product Id) The identifier of the product associated with the plan price.
name	any <int> (Name) The name of the plan price.
description	any <varchar> (Description) The description of the plan price.
category	any <date> (Category) The category of the plan price.
charge_model	any <varchar> (Charge Model) The charge model of the plan price. Possible values: `flat_fee` - The plan price is a flat fee. `per_unit` - The plan price is a per unit fee. `tiered` - The plan price is a tiered fee. `volume` - The plan price is a volume fee.
accounting_account_code	any <varchar> (Account) The accounting account code of the plan price.
list_price	any <double> (List Price) The list price of the plan price.
list_price_base	any <varchar> (List Price Base) The list price base of the plan price.
uom	any <varchar> (UOM) The unit of measure (UOM) of the plan price.
included_units	any <varchar> (Included Units) The included units of the plan price.
default_quantity	any <varchar> (Default Quantity) The default quantity of the plan price.
trigger_condition	any <varchar> (Trigger Condition) The trigger condition of the plan price.
end_date	any <varchar> (End Date) The end date of the plan price.
billing_timming	any <varchar> (Billing Timming) The billing timming of the plan price. Possible values: `in_advance` - The plan price is billed in advance. `in_arrears` - The plan price is billed in arrears.
billing_period_alignment	any <varchar> (Billing Period Alignment) The billing period alignment of the plan price.
usage_records_rating_option	any <varchar> (Usage Records Rating Option) The usage records rating option of the plan price.
billing_period_id	any <int> (Billing Period) The identifier of the billing period associated with the plan price.
billing_period_months_weeks	any <int> (Billing Period Months Weeks) The billing period months weeks of the plan price.
billing_month_id	any <int> (Billing Month) The identifier of the billing month associated with the plan price.
billing_day_type_id	any <int> (Billing Day) The identifier of the billing day associated with the plan price.
billing_week_day_id	any <int> (Billing Day) The identifier of the billing day associated with the plan price.
created_at	any <timestamp> (Created At) The date and time when the plan price was created.
assigned_to	any <char> (Assigned To) The user who is assigned to the plan price.
data_source	any <char> (Data Source) The data source of the plan price.

Responses

Request samples

Payload

Content type

application/json

{"id": "__test__pp3VnHhSBWl7eY2bl",
"plan_id": 1,
"product_id": 1,
"name": 1,
"description": "Plan 1 description",
"category": "2020-01-01",
"charge_model": "flat_fee",
"accounting_account_code": "12345",
"list_price": 100,
"list_price_base": "USD",
"uom": "each",
"included_units": "1",
"default_quantity": "1",
"trigger_condition": "1",
"end_date": "2020-01-01",
"billing_timming": "in_advance",
"billing_period_alignment": "1",
"usage_records_rating_option": "1",
"billing_period_id": 1,
"billing_period_months_weeks": 1,
"billing_month_id": 1,
"billing_day_type_id": 1,
"billing_week_day_id": 1,
"created_at": "2020-01-01T00:00:00Z",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Response samples

Content type

application/json

{"id": "__test__pp3VnHhSBWl7eY2bl",
"plan_id": 1,
"product_id": 1,
"name": 1,
"description": "Plan 1 description",
"category": "2020-01-01",
"charge_model": "flat_fee",
"accounting_account_code": "12345",
"list_price": 100,
"list_price_base": "USD",
"uom": "each",
"included_units": "1",
"default_quantity": "1",
"trigger_condition": "1",
"end_date": "2020-01-01",
"billing_timming": "in_advance",
"billing_period_alignment": "1",
"usage_records_rating_option": "1",
"billing_period_id": 1,
"billing_period_months_weeks": 1,
"billing_month_id": 1,
"billing_day_type_id": 1,
"billing_week_day_id": 1,
"created_at": "2020-01-01T00:00:00Z",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Get PlanPrice information

Returns PlanPrice data

path Parameters

plan-price

required

char

PlanPrice id

Responses

Response Schema: application/json

id	any <varchar> (Id) The unique identifier for the plan price.
plan_id	any <int> (Plan Id) The identifier of the plan associated with the plan price.
product_id	any <int> (Product Id) The identifier of the product associated with the plan price.
name	any <int> (Name) The name of the plan price.
description	any <varchar> (Description) The description of the plan price.
category	any <date> (Category) The category of the plan price.
charge_model	any <varchar> (Charge Model) The charge model of the plan price. Possible values: `flat_fee` - The plan price is a flat fee. `per_unit` - The plan price is a per unit fee. `tiered` - The plan price is a tiered fee. `volume` - The plan price is a volume fee.
accounting_account_code	any <varchar> (Account) The accounting account code of the plan price.
list_price	any <double> (List Price) The list price of the plan price.
list_price_base	any <varchar> (List Price Base) The list price base of the plan price.
uom	any <varchar> (UOM) The unit of measure (UOM) of the plan price.
included_units	any <varchar> (Included Units) The included units of the plan price.
default_quantity	any <varchar> (Default Quantity) The default quantity of the plan price.
trigger_condition	any <varchar> (Trigger Condition) The trigger condition of the plan price.
end_date	any <varchar> (End Date) The end date of the plan price.
billing_timming	any <varchar> (Billing Timming) The billing timming of the plan price. Possible values: `in_advance` - The plan price is billed in advance. `in_arrears` - The plan price is billed in arrears.
billing_period_alignment	any <varchar> (Billing Period Alignment) The billing period alignment of the plan price.
usage_records_rating_option	any <varchar> (Usage Records Rating Option) The usage records rating option of the plan price.
billing_period_id	any <int> (Billing Period) The identifier of the billing period associated with the plan price.
billing_period_months_weeks	any <int> (Billing Period Months Weeks) The billing period months weeks of the plan price.
billing_month_id	any <int> (Billing Month) The identifier of the billing month associated with the plan price.
billing_day_type_id	any <int> (Billing Day) The identifier of the billing day associated with the plan price.
billing_week_day_id	any <int> (Billing Day) The identifier of the billing day associated with the plan price.
created_at	any <timestamp> (Created At) The date and time when the plan price was created.
assigned_to	any <char> (Assigned To) The user who is assigned to the plan price.
data_source	any <char> (Data Source) The data source of the plan price.

Response samples

Content type

application/json

{"id": "__test__pp3VnHhSBWl7eY2bl",
"plan_id": 1,
"product_id": 1,
"name": 1,
"description": "Plan 1 description",
"category": "2020-01-01",
"charge_model": "flat_fee",
"accounting_account_code": "12345",
"list_price": 100,
"list_price_base": "USD",
"uom": "each",
"included_units": "1",
"default_quantity": "1",
"trigger_condition": "1",
"end_date": "2020-01-01",
"billing_timming": "in_advance",
"billing_period_alignment": "1",
"usage_records_rating_option": "1",
"billing_period_id": 1,
"billing_period_months_weeks": 1,
"billing_month_id": 1,
"billing_day_type_id": 1,
"billing_week_day_id": 1,
"created_at": "2020-01-01T00:00:00Z",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Update existing PlanPrice

Returns updated PlanPrice data

path Parameters

plan-price

required

char

PlanPrice id

Request Body schema: application/json
required

id	any <varchar> (Id) The unique identifier for the plan price.
plan_id	any <int> (Plan Id) The identifier of the plan associated with the plan price.
product_id	any <int> (Product Id) The identifier of the product associated with the plan price.
name	any <int> (Name) The name of the plan price.
description	any <varchar> (Description) The description of the plan price.
category	any <date> (Category) The category of the plan price.
charge_model	any <varchar> (Charge Model) The charge model of the plan price. Possible values: `flat_fee` - The plan price is a flat fee. `per_unit` - The plan price is a per unit fee. `tiered` - The plan price is a tiered fee. `volume` - The plan price is a volume fee.
accounting_account_code	any <varchar> (Account) The accounting account code of the plan price.
list_price	any <double> (List Price) The list price of the plan price.
list_price_base	any <varchar> (List Price Base) The list price base of the plan price.
uom	any <varchar> (UOM) The unit of measure (UOM) of the plan price.
included_units	any <varchar> (Included Units) The included units of the plan price.
default_quantity	any <varchar> (Default Quantity) The default quantity of the plan price.
trigger_condition	any <varchar> (Trigger Condition) The trigger condition of the plan price.
end_date	any <varchar> (End Date) The end date of the plan price.
billing_timming	any <varchar> (Billing Timming) The billing timming of the plan price. Possible values: `in_advance` - The plan price is billed in advance. `in_arrears` - The plan price is billed in arrears.
billing_period_alignment	any <varchar> (Billing Period Alignment) The billing period alignment of the plan price.
usage_records_rating_option	any <varchar> (Usage Records Rating Option) The usage records rating option of the plan price.
billing_period_id	any <int> (Billing Period) The identifier of the billing period associated with the plan price.
billing_period_months_weeks	any <int> (Billing Period Months Weeks) The billing period months weeks of the plan price.
billing_month_id	any <int> (Billing Month) The identifier of the billing month associated with the plan price.
billing_day_type_id	any <int> (Billing Day) The identifier of the billing day associated with the plan price.
billing_week_day_id	any <int> (Billing Day) The identifier of the billing day associated with the plan price.
created_at	any <timestamp> (Created At) The date and time when the plan price was created.
assigned_to	any <char> (Assigned To) The user who is assigned to the plan price.
data_source	any <char> (Data Source) The data source of the plan price.

Responses

Response Schema: application/json

id	any <varchar> (Id) The unique identifier for the plan price.
plan_id	any <int> (Plan Id) The identifier of the plan associated with the plan price.
product_id	any <int> (Product Id) The identifier of the product associated with the plan price.
name	any <int> (Name) The name of the plan price.
description	any <varchar> (Description) The description of the plan price.
category	any <date> (Category) The category of the plan price.
charge_model	any <varchar> (Charge Model) The charge model of the plan price. Possible values: `flat_fee` - The plan price is a flat fee. `per_unit` - The plan price is a per unit fee. `tiered` - The plan price is a tiered fee. `volume` - The plan price is a volume fee.
accounting_account_code	any <varchar> (Account) The accounting account code of the plan price.
list_price	any <double> (List Price) The list price of the plan price.
list_price_base	any <varchar> (List Price Base) The list price base of the plan price.
uom	any <varchar> (UOM) The unit of measure (UOM) of the plan price.
included_units	any <varchar> (Included Units) The included units of the plan price.
default_quantity	any <varchar> (Default Quantity) The default quantity of the plan price.
trigger_condition	any <varchar> (Trigger Condition) The trigger condition of the plan price.
end_date	any <varchar> (End Date) The end date of the plan price.
billing_timming	any <varchar> (Billing Timming) The billing timming of the plan price. Possible values: `in_advance` - The plan price is billed in advance. `in_arrears` - The plan price is billed in arrears.
billing_period_alignment	any <varchar> (Billing Period Alignment) The billing period alignment of the plan price.
usage_records_rating_option	any <varchar> (Usage Records Rating Option) The usage records rating option of the plan price.
billing_period_id	any <int> (Billing Period) The identifier of the billing period associated with the plan price.
billing_period_months_weeks	any <int> (Billing Period Months Weeks) The billing period months weeks of the plan price.
billing_month_id	any <int> (Billing Month) The identifier of the billing month associated with the plan price.
billing_day_type_id	any <int> (Billing Day) The identifier of the billing day associated with the plan price.
billing_week_day_id	any <int> (Billing Day) The identifier of the billing day associated with the plan price.
created_at	any <timestamp> (Created At) The date and time when the plan price was created.
assigned_to	any <char> (Assigned To) The user who is assigned to the plan price.
data_source	any <char> (Data Source) The data source of the plan price.

Request samples

Payload

Content type

application/json

{"id": "__test__pp3VnHhSBWl7eY2bl",
"plan_id": 1,
"product_id": 1,
"name": 1,
"description": "Plan 1 description",
"category": "2020-01-01",
"charge_model": "flat_fee",
"accounting_account_code": "12345",
"list_price": 100,
"list_price_base": "USD",
"uom": "each",
"included_units": "1",
"default_quantity": "1",
"trigger_condition": "1",
"end_date": "2020-01-01",
"billing_timming": "in_advance",
"billing_period_alignment": "1",
"usage_records_rating_option": "1",
"billing_period_id": 1,
"billing_period_months_weeks": 1,
"billing_month_id": 1,
"billing_day_type_id": 1,
"billing_week_day_id": 1,
"created_at": "2020-01-01T00:00:00Z",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Response samples

Content type

application/json

{"id": "__test__pp3VnHhSBWl7eY2bl",
"plan_id": 1,
"product_id": 1,
"name": 1,
"description": "Plan 1 description",
"category": "2020-01-01",
"charge_model": "flat_fee",
"accounting_account_code": "12345",
"list_price": 100,
"list_price_base": "USD",
"uom": "each",
"included_units": "1",
"default_quantity": "1",
"trigger_condition": "1",
"end_date": "2020-01-01",
"billing_timming": "in_advance",
"billing_period_alignment": "1",
"usage_records_rating_option": "1",
"billing_period_id": 1,
"billing_period_months_weeks": 1,
"billing_month_id": 1,
"billing_day_type_id": 1,
"billing_week_day_id": 1,
"created_at": "2020-01-01T00:00:00Z",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Delete existing PlanPrice

Deletes a record and returns deleted record

path Parameters

plan-price

required

char

PlanPrice id

Responses

Response samples

Content type

application/json

{"id": "__test__pp3VnHhSBWl7eY2bl",
"plan_id": 1,
"product_id": 1,
"name": 1,
"description": "Plan 1 description",
"category": "2020-01-01",
"charge_model": "flat_fee",
"accounting_account_code": "12345",
"list_price": 100,
"list_price_base": "USD",
"uom": "each",
"included_units": "1",
"default_quantity": "1",
"trigger_condition": "1",
"end_date": "2020-01-01",
"billing_timming": "in_advance",
"billing_period_alignment": "1",
"usage_records_rating_option": "1",
"billing_period_id": 1,
"billing_period_months_weeks": 1,
"billing_month_id": 1,
"billing_day_type_id": 1,
"billing_week_day_id": 1,
"created_at": "2020-01-01T00:00:00Z",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Get with-relations list of PlanPrice

Returns list of PlanPrice with all foreign keys

Responses

Response Schema: application/json

id	any <varchar> (Id) The unique identifier for the plan price.
plan_id	any <int> (Plan Id) The identifier of the plan associated with the plan price.
product_id	any <int> (Product Id) The identifier of the product associated with the plan price.
name	any <int> (Name) The name of the plan price.
description	any <varchar> (Description) The description of the plan price.
category	any <date> (Category) The category of the plan price.
charge_model	any <varchar> (Charge Model) The charge model of the plan price. Possible values: `flat_fee` - The plan price is a flat fee. `per_unit` - The plan price is a per unit fee. `tiered` - The plan price is a tiered fee. `volume` - The plan price is a volume fee.
accounting_account_code	any <varchar> (Account) The accounting account code of the plan price.
list_price	any <double> (List Price) The list price of the plan price.
list_price_base	any <varchar> (List Price Base) The list price base of the plan price.
uom	any <varchar> (UOM) The unit of measure (UOM) of the plan price.
included_units	any <varchar> (Included Units) The included units of the plan price.
default_quantity	any <varchar> (Default Quantity) The default quantity of the plan price.
trigger_condition	any <varchar> (Trigger Condition) The trigger condition of the plan price.
end_date	any <varchar> (End Date) The end date of the plan price.
billing_timming	any <varchar> (Billing Timming) The billing timming of the plan price. Possible values: `in_advance` - The plan price is billed in advance. `in_arrears` - The plan price is billed in arrears.
billing_period_alignment	any <varchar> (Billing Period Alignment) The billing period alignment of the plan price.
usage_records_rating_option	any <varchar> (Usage Records Rating Option) The usage records rating option of the plan price.
billing_period_id	any <int> (Billing Period) The identifier of the billing period associated with the plan price.
billing_period_months_weeks	any <int> (Billing Period Months Weeks) The billing period months weeks of the plan price.
billing_month_id	any <int> (Billing Month) The identifier of the billing month associated with the plan price.
billing_day_type_id	any <int> (Billing Day) The identifier of the billing day associated with the plan price.
billing_week_day_id	any <int> (Billing Day) The identifier of the billing day associated with the plan price.
created_at	any <timestamp> (Created At) The date and time when the plan price was created.
assigned_to	any <char> (Assigned To) The user who is assigned to the plan price.
data_source	any <char> (Data Source) The data source of the plan price.

Response samples

Content type

application/json

{"id": "__test__pp3VnHhSBWl7eY2bl",
"plan_id": 1,
"product_id": 1,
"name": 1,
"description": "Plan 1 description",
"category": "2020-01-01",
"charge_model": "flat_fee",
"accounting_account_code": "12345",
"list_price": 100,
"list_price_base": "USD",
"uom": "each",
"included_units": "1",
"default_quantity": "1",
"trigger_condition": "1",
"end_date": "2020-01-01",
"billing_timming": "in_advance",
"billing_period_alignment": "1",
"usage_records_rating_option": "1",
"billing_period_id": 1,
"billing_period_months_weeks": 1,
"billing_month_id": 1,
"billing_day_type_id": 1,
"billing_week_day_id": 1,
"created_at": "2020-01-01T00:00:00Z",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Get related list of PlanPrice

Returns one-to-many list of PlanPrice with related Module

path Parameters

id required	char PlanPrice id
related required	varchar hasMany relation name

Responses

Response Schema: application/json

id	any <varchar> (Id) The unique identifier for the plan price.
plan_id	any <int> (Plan Id) The identifier of the plan associated with the plan price.
product_id	any <int> (Product Id) The identifier of the product associated with the plan price.
name	any <int> (Name) The name of the plan price.
description	any <varchar> (Description) The description of the plan price.
category	any <date> (Category) The category of the plan price.
charge_model	any <varchar> (Charge Model) The charge model of the plan price. Possible values: `flat_fee` - The plan price is a flat fee. `per_unit` - The plan price is a per unit fee. `tiered` - The plan price is a tiered fee. `volume` - The plan price is a volume fee.
accounting_account_code	any <varchar> (Account) The accounting account code of the plan price.
list_price	any <double> (List Price) The list price of the plan price.
list_price_base	any <varchar> (List Price Base) The list price base of the plan price.
uom	any <varchar> (UOM) The unit of measure (UOM) of the plan price.
included_units	any <varchar> (Included Units) The included units of the plan price.
default_quantity	any <varchar> (Default Quantity) The default quantity of the plan price.
trigger_condition	any <varchar> (Trigger Condition) The trigger condition of the plan price.
end_date	any <varchar> (End Date) The end date of the plan price.
billing_timming	any <varchar> (Billing Timming) The billing timming of the plan price. Possible values: `in_advance` - The plan price is billed in advance. `in_arrears` - The plan price is billed in arrears.
billing_period_alignment	any <varchar> (Billing Period Alignment) The billing period alignment of the plan price.
usage_records_rating_option	any <varchar> (Usage Records Rating Option) The usage records rating option of the plan price.
billing_period_id	any <int> (Billing Period) The identifier of the billing period associated with the plan price.
billing_period_months_weeks	any <int> (Billing Period Months Weeks) The billing period months weeks of the plan price.
billing_month_id	any <int> (Billing Month) The identifier of the billing month associated with the plan price.
billing_day_type_id	any <int> (Billing Day) The identifier of the billing day associated with the plan price.
billing_week_day_id	any <int> (Billing Day) The identifier of the billing day associated with the plan price.
created_at	any <timestamp> (Created At) The date and time when the plan price was created.
assigned_to	any <char> (Assigned To) The user who is assigned to the plan price.
data_source	any <char> (Data Source) The data source of the plan price.

Response samples

Content type

application/json

{"id": "__test__pp3VnHhSBWl7eY2bl",
"plan_id": 1,
"product_id": 1,
"name": 1,
"description": "Plan 1 description",
"category": "2020-01-01",
"charge_model": "flat_fee",
"accounting_account_code": "12345",
"list_price": 100,
"list_price_base": "USD",
"uom": "each",
"included_units": "1",
"default_quantity": "1",
"trigger_condition": "1",
"end_date": "2020-01-01",
"billing_timming": "in_advance",
"billing_period_alignment": "1",
"usage_records_rating_option": "1",
"billing_period_id": 1,
"billing_period_months_weeks": 1,
"billing_month_id": 1,
"billing_day_type_id": 1,
"billing_week_day_id": 1,
"created_at": "2020-01-01T00:00:00Z",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Get filtered list of PlanPrice

Returns list of PlanPrice with quick filters

path Parameters

fieldName

required

varchar

Field name to apply filter E.g. 'name' = 'John'

Responses

Response Schema: application/json

id	any <varchar> (Id) The unique identifier for the plan price.
plan_id	any <int> (Plan Id) The identifier of the plan associated with the plan price.
product_id	any <int> (Product Id) The identifier of the product associated with the plan price.
name	any <int> (Name) The name of the plan price.
description	any <varchar> (Description) The description of the plan price.
category	any <date> (Category) The category of the plan price.
charge_model	any <varchar> (Charge Model) The charge model of the plan price. Possible values: `flat_fee` - The plan price is a flat fee. `per_unit` - The plan price is a per unit fee. `tiered` - The plan price is a tiered fee. `volume` - The plan price is a volume fee.
accounting_account_code	any <varchar> (Account) The accounting account code of the plan price.
list_price	any <double> (List Price) The list price of the plan price.
list_price_base	any <varchar> (List Price Base) The list price base of the plan price.
uom	any <varchar> (UOM) The unit of measure (UOM) of the plan price.
included_units	any <varchar> (Included Units) The included units of the plan price.
default_quantity	any <varchar> (Default Quantity) The default quantity of the plan price.
trigger_condition	any <varchar> (Trigger Condition) The trigger condition of the plan price.
end_date	any <varchar> (End Date) The end date of the plan price.
billing_timming	any <varchar> (Billing Timming) The billing timming of the plan price. Possible values: `in_advance` - The plan price is billed in advance. `in_arrears` - The plan price is billed in arrears.
billing_period_alignment	any <varchar> (Billing Period Alignment) The billing period alignment of the plan price.
usage_records_rating_option	any <varchar> (Usage Records Rating Option) The usage records rating option of the plan price.
billing_period_id	any <int> (Billing Period) The identifier of the billing period associated with the plan price.
billing_period_months_weeks	any <int> (Billing Period Months Weeks) The billing period months weeks of the plan price.
billing_month_id	any <int> (Billing Month) The identifier of the billing month associated with the plan price.
billing_day_type_id	any <int> (Billing Day) The identifier of the billing day associated with the plan price.
billing_week_day_id	any <int> (Billing Day) The identifier of the billing day associated with the plan price.
created_at	any <timestamp> (Created At) The date and time when the plan price was created.
assigned_to	any <char> (Assigned To) The user who is assigned to the plan price.
data_source	any <char> (Data Source) The data source of the plan price.

Response samples

Content type

application/json

{"id": "__test__pp3VnHhSBWl7eY2bl",
"plan_id": 1,
"product_id": 1,
"name": 1,
"description": "Plan 1 description",
"category": "2020-01-01",
"charge_model": "flat_fee",
"accounting_account_code": "12345",
"list_price": 100,
"list_price_base": "USD",
"uom": "each",
"included_units": "1",
"default_quantity": "1",
"trigger_condition": "1",
"end_date": "2020-01-01",
"billing_timming": "in_advance",
"billing_period_alignment": "1",
"usage_records_rating_option": "1",
"billing_period_id": 1,
"billing_period_months_weeks": 1,
"billing_month_id": 1,
"billing_day_type_id": 1,
"billing_week_day_id": 1,
"created_at": "2020-01-01T00:00:00Z",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Filter PlanPrice with nested conditions

Returns filtered PlanPrice data

query Parameters

$equals	varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value'
$not_equals	varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value'
$starts	varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value'
$ends	varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value'
$contains	varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value'
$in	varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second']
$is_null	varchar Match if field have null value. E.g. filter[column_name][$is_null] = true
$not_null	varchar Match if field is not null. E.g. filter[column_name][$not_null] = true
$not_in	varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second']
$lt	varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value'
$lte	varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value'
$gt	varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value'
$gte	varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value'
$sortorder	varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc\|desc'
$limit	varchar Limit results E.g. filter[$limit] = '50' \| For offset: filter[$offset] = '20'
$paginate	varchar Paginate results E.g. filter[$paginate] = '50

Responses

Response samples

Content type

application/json

{"id": "__test__pp3VnHhSBWl7eY2bl",
"plan_id": 1,
"product_id": 1,
"name": 1,
"description": "Plan 1 description",
"category": "2020-01-01",
"charge_model": "flat_fee",
"accounting_account_code": "12345",
"list_price": 100,
"list_price_base": "USD",
"uom": "each",
"included_units": "1",
"default_quantity": "1",
"trigger_condition": "1",
"end_date": "2020-01-01",
"billing_timming": "in_advance",
"billing_period_alignment": "1",
"usage_records_rating_option": "1",
"billing_period_id": 1,
"billing_period_months_weeks": 1,
"billing_month_id": 1,
"billing_day_type_id": 1,
"billing_week_day_id": 1,
"created_at": "2020-01-01T00:00:00Z",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Bulk destroy PlanPrice

Returns deleted PlanPrice data

query Parameters

ids

required

varchar

Array of ids to be deleted.

Responses

Response samples

Content type

application/json

{"id": "__test__pp3VnHhSBWl7eY2bl",
"plan_id": 1,
"product_id": 1,
"name": 1,
"description": "Plan 1 description",
"category": "2020-01-01",
"charge_model": "flat_fee",
"accounting_account_code": "12345",
"list_price": 100,
"list_price_base": "USD",
"uom": "each",
"included_units": "1",
"default_quantity": "1",
"trigger_condition": "1",
"end_date": "2020-01-01",
"billing_timming": "in_advance",
"billing_period_alignment": "1",
"usage_records_rating_option": "1",
"billing_period_id": 1,
"billing_period_months_weeks": 1,
"billing_month_id": 1,
"billing_day_type_id": 1,
"billing_week_day_id": 1,
"created_at": "2020-01-01T00:00:00Z",
"assigned_to": "__test__us3VnHhSBWl7eY2bl",
"data_source": "__test__ds3VnHhSBWl7eY2bl"
}

Users

A user is a person who can access your SubscriptionFlow instance. The user details include the user ID, email, first name, last name, role, status, address information, and locale.

Get list of Users

Retrieve a comprehensive list of all registered users. This endpoint returns a summary of each user, including basic details and statuses.

Responses

Response Schema: application/json

id	any <varchar> (Id) A unique and immutable identifier for the user.
email	any <varchar> (Email) The email address of the user.
user_type	any <varchar> (User Type) The type of the user. Possible values are `1` - The user is an admin. `2` - The user is a regular user.
first_name	any <varchar> (First Name) The first name of the user.
last_name	any <varchar> (Last Name) The last name of the user.
nationality	any <varchar> (Nationality) The nationality of the user.
username	any <varchar> (Username) The username of the user.
status	any <varchar> (Status) The status of the user. Possible values are `1` - The user is active. `0` - The user is inactive.
designation_id	any <varchar> (Designation Id) The identifier of the designation associated with the user.
alias	any <varchar> (Alias) The alias of the user.
phone	any <varchar> (Phone) The phone number of the user.
mobile	any <varchar> (Mobile) The mobile number of the user.
website	any <varchar> (Website) The website of the user.
fax	any <varchar> (Fax) The fax number of the user.
date_of_birth	any <varchar> (Date Of Birth) The date of birth of the user.
street	any <varchar> (Street) The street address of the user.
city	any <varchar> (City) The city of the user.
state	any <varchar> (State) The state of the user.
zip_code	any <varchar> (Zip Code) The zip code of the user.
country	any <varchar> (Country) The country of the user.
time_format	any <varchar> (Time Format) The time format of the user.
timezone	any <varchar> (Timezone) The timezone of the user.
signature	any <varchar> (Signature) The signature of the user.
data_source	any <char> (Data Source) The source of data for the user.

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"email": "[email protected]",
"user_type": "1",
"first_name": "John",
"last_name": "Doe",
"nationality": "US",
"username": "johndoe",
"status": "1",
"designation_id": "__test__sf5sukSOXduqmOY",
"alias": "johndoe",
"phone": "1234567890",
"mobile": "1234567890",
"website": "www.test.com",
"fax": "1234567890",
"date_of_birth": "2000-11-01",
"street": "123 Main St",
"city": "New York",
"state": "New York",
"zip_code": "12345",
"country": "US",
"time_format": "12",
"timezone": "America/New_York",
"signature": "John Doe",
"data_source": "System"
}

Store a new User

Create and save a new user in the system. Provide the necessary user details in the request body to successfully register the new user.

Request Body schema: application/json

id	any <varchar> (Id) A unique and immutable identifier for the user.
email	any <varchar> (Email) The email address of the user.
user_type	any <varchar> (User Type) The type of the user. Possible values are `1` - The user is an admin. `2` - The user is a regular user.
first_name	any <varchar> (First Name) The first name of the user.
last_name	any <varchar> (Last Name) The last name of the user.
nationality	any <varchar> (Nationality) The nationality of the user.
username	any <varchar> (Username) The username of the user.
status	any <varchar> (Status) The status of the user. Possible values are `1` - The user is active. `0` - The user is inactive.
designation_id	any <varchar> (Designation Id) The identifier of the designation associated with the user.
alias	any <varchar> (Alias) The alias of the user.
phone	any <varchar> (Phone) The phone number of the user.
mobile	any <varchar> (Mobile) The mobile number of the user.
website	any <varchar> (Website) The website of the user.
fax	any <varchar> (Fax) The fax number of the user.
date_of_birth	any <varchar> (Date Of Birth) The date of birth of the user.
street	any <varchar> (Street) The street address of the user.
city	any <varchar> (City) The city of the user.
state	any <varchar> (State) The state of the user.
zip_code	any <varchar> (Zip Code) The zip code of the user.
country	any <varchar> (Country) The country of the user.
time_format	any <varchar> (Time Format) The time format of the user.
timezone	any <varchar> (Timezone) The timezone of the user.
signature	any <varchar> (Signature) The signature of the user.
data_source	any <char> (Data Source) The source of data for the user.

Responses

Request samples

Payload

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"email": "[email protected]",
"user_type": "1",
"first_name": "John",
"last_name": "Doe",
"nationality": "US",
"username": "johndoe",
"status": "1",
"designation_id": "__test__sf5sukSOXduqmOY",
"alias": "johndoe",
"phone": "1234567890",
"mobile": "1234567890",
"website": "www.test.com",
"fax": "1234567890",
"date_of_birth": "2000-11-01",
"street": "123 Main St",
"city": "New York",
"state": "New York",
"zip_code": "12345",
"country": "US",
"time_format": "12",
"timezone": "America/New_York",
"signature": "John Doe",
"data_source": "System"
}

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"email": "[email protected]",
"user_type": "1",
"first_name": "John",
"last_name": "Doe",
"nationality": "US",
"username": "johndoe",
"status": "1",
"designation_id": "__test__sf5sukSOXduqmOY",
"alias": "johndoe",
"phone": "1234567890",
"mobile": "1234567890",
"website": "www.test.com",
"fax": "1234567890",
"date_of_birth": "2000-11-01",
"street": "123 Main St",
"city": "New York",
"state": "New York",
"zip_code": "12345",
"country": "US",
"time_format": "12",
"timezone": "America/New_York",
"signature": "John Doe",
"data_source": "System"
}

Get User information

Retrieve detailed information about a specific user. This operation requires the user ID to fetch and display the user's data.

path Parameters

user_id

required

string

The unique identifier of user

Responses

Response Schema: application/json

id	any <varchar> (Id) A unique and immutable identifier for the user.
email	any <varchar> (Email) The email address of the user.
user_type	any <varchar> (User Type) The type of the user. Possible values are `1` - The user is an admin. `2` - The user is a regular user.
first_name	any <varchar> (First Name) The first name of the user.
last_name	any <varchar> (Last Name) The last name of the user.
nationality	any <varchar> (Nationality) The nationality of the user.
username	any <varchar> (Username) The username of the user.
status	any <varchar> (Status) The status of the user. Possible values are `1` - The user is active. `0` - The user is inactive.
designation_id	any <varchar> (Designation Id) The identifier of the designation associated with the user.
alias	any <varchar> (Alias) The alias of the user.
phone	any <varchar> (Phone) The phone number of the user.
mobile	any <varchar> (Mobile) The mobile number of the user.
website	any <varchar> (Website) The website of the user.
fax	any <varchar> (Fax) The fax number of the user.
date_of_birth	any <varchar> (Date Of Birth) The date of birth of the user.
street	any <varchar> (Street) The street address of the user.
city	any <varchar> (City) The city of the user.
state	any <varchar> (State) The state of the user.
zip_code	any <varchar> (Zip Code) The zip code of the user.
country	any <varchar> (Country) The country of the user.
time_format	any <varchar> (Time Format) The time format of the user.
timezone	any <varchar> (Timezone) The timezone of the user.
signature	any <varchar> (Signature) The signature of the user.
data_source	any <char> (Data Source) The source of data for the user.

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"email": "[email protected]",
"user_type": "1",
"first_name": "John",
"last_name": "Doe",
"nationality": "US",
"username": "johndoe",
"status": "1",
"designation_id": "__test__sf5sukSOXduqmOY",
"alias": "johndoe",
"phone": "1234567890",
"mobile": "1234567890",
"website": "www.test.com",
"fax": "1234567890",
"date_of_birth": "2000-11-01",
"street": "123 Main St",
"city": "New York",
"state": "New York",
"zip_code": "12345",
"country": "US",
"time_format": "12",
"timezone": "America/New_York",
"signature": "John Doe",
"data_source": "System"
}

Update existing User

Modify the details of an existing user. Provide the user ID and updated information in the request body to apply changes.

path Parameters

user_id

required

string

The unique identifier of user

Request Body schema: application/json
required

id	any <varchar> (Id) A unique and immutable identifier for the user.
email	any <varchar> (Email) The email address of the user.
user_type	any <varchar> (User Type) The type of the user. Possible values are `1` - The user is an admin. `2` - The user is a regular user.
first_name	any <varchar> (First Name) The first name of the user.
last_name	any <varchar> (Last Name) The last name of the user.
nationality	any <varchar> (Nationality) The nationality of the user.
username	any <varchar> (Username) The username of the user.
status	any <varchar> (Status) The status of the user. Possible values are `1` - The user is active. `0` - The user is inactive.
designation_id	any <varchar> (Designation Id) The identifier of the designation associated with the user.
alias	any <varchar> (Alias) The alias of the user.
phone	any <varchar> (Phone) The phone number of the user.
mobile	any <varchar> (Mobile) The mobile number of the user.
website	any <varchar> (Website) The website of the user.
fax	any <varchar> (Fax) The fax number of the user.
date_of_birth	any <varchar> (Date Of Birth) The date of birth of the user.
street	any <varchar> (Street) The street address of the user.
city	any <varchar> (City) The city of the user.
state	any <varchar> (State) The state of the user.
zip_code	any <varchar> (Zip Code) The zip code of the user.
country	any <varchar> (Country) The country of the user.
time_format	any <varchar> (Time Format) The time format of the user.
timezone	any <varchar> (Timezone) The timezone of the user.
signature	any <varchar> (Signature) The signature of the user.
data_source	any <char> (Data Source) The source of data for the user.

Responses

Response Schema: application/json

id	any <varchar> (Id) A unique and immutable identifier for the user.
email	any <varchar> (Email) The email address of the user.
user_type	any <varchar> (User Type) The type of the user. Possible values are `1` - The user is an admin. `2` - The user is a regular user.
first_name	any <varchar> (First Name) The first name of the user.
last_name	any <varchar> (Last Name) The last name of the user.
nationality	any <varchar> (Nationality) The nationality of the user.
username	any <varchar> (Username) The username of the user.
status	any <varchar> (Status) The status of the user. Possible values are `1` - The user is active. `0` - The user is inactive.
designation_id	any <varchar> (Designation Id) The identifier of the designation associated with the user.
alias	any <varchar> (Alias) The alias of the user.
phone	any <varchar> (Phone) The phone number of the user.
mobile	any <varchar> (Mobile) The mobile number of the user.
website	any <varchar> (Website) The website of the user.
fax	any <varchar> (Fax) The fax number of the user.
date_of_birth	any <varchar> (Date Of Birth) The date of birth of the user.
street	any <varchar> (Street) The street address of the user.
city	any <varchar> (City) The city of the user.
state	any <varchar> (State) The state of the user.
zip_code	any <varchar> (Zip Code) The zip code of the user.
country	any <varchar> (Country) The country of the user.
time_format	any <varchar> (Time Format) The time format of the user.
timezone	any <varchar> (Timezone) The timezone of the user.
signature	any <varchar> (Signature) The signature of the user.
data_source	any <char> (Data Source) The source of data for the user.

Request samples

Payload

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"email": "[email protected]",
"user_type": "1",
"first_name": "John",
"last_name": "Doe",
"nationality": "US",
"username": "johndoe",
"status": "1",
"designation_id": "__test__sf5sukSOXduqmOY",
"alias": "johndoe",
"phone": "1234567890",
"mobile": "1234567890",
"website": "www.test.com",
"fax": "1234567890",
"date_of_birth": "2000-11-01",
"street": "123 Main St",
"city": "New York",
"state": "New York",
"zip_code": "12345",
"country": "US",
"time_format": "12",
"timezone": "America/New_York",
"signature": "John Doe",
"data_source": "System"
}

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"email": "[email protected]",
"user_type": "1",
"first_name": "John",
"last_name": "Doe",
"nationality": "US",
"username": "johndoe",
"status": "1",
"designation_id": "__test__sf5sukSOXduqmOY",
"alias": "johndoe",
"phone": "1234567890",
"mobile": "1234567890",
"website": "www.test.com",
"fax": "1234567890",
"date_of_birth": "2000-11-01",
"street": "123 Main St",
"city": "New York",
"state": "New York",
"zip_code": "12345",
"country": "US",
"time_format": "12",
"timezone": "America/New_York",
"signature": "John Doe",
"data_source": "System"
}

Delete existing User

Permanently remove a specific user from the system. This operation requires the user ID to identify and delete the user record.

path Parameters

user_id

required

string

The unique identifier of user

Responses

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"email": "[email protected]",
"user_type": "1",
"first_name": "John",
"last_name": "Doe",
"nationality": "US",
"username": "johndoe",
"status": "1",
"designation_id": "__test__sf5sukSOXduqmOY",
"alias": "johndoe",
"phone": "1234567890",
"mobile": "1234567890",
"website": "www.test.com",
"fax": "1234567890",
"date_of_birth": "2000-11-01",
"street": "123 Main St",
"city": "New York",
"state": "New York",
"zip_code": "12345",
"country": "US",
"time_format": "12",
"timezone": "America/New_York",
"signature": "John Doe",
"data_source": "System"
}

Get with-relations list of Users

Returns list of Users with all foreign keys

Responses

Response Schema: application/json

id	any <varchar> (Id) A unique and immutable identifier for the user.
email	any <varchar> (Email) The email address of the user.
user_type	any <varchar> (User Type) The type of the user. Possible values are `1` - The user is an admin. `2` - The user is a regular user.
first_name	any <varchar> (First Name) The first name of the user.
last_name	any <varchar> (Last Name) The last name of the user.
nationality	any <varchar> (Nationality) The nationality of the user.
username	any <varchar> (Username) The username of the user.
status	any <varchar> (Status) The status of the user. Possible values are `1` - The user is active. `0` - The user is inactive.
designation_id	any <varchar> (Designation Id) The identifier of the designation associated with the user.
alias	any <varchar> (Alias) The alias of the user.
phone	any <varchar> (Phone) The phone number of the user.
mobile	any <varchar> (Mobile) The mobile number of the user.
website	any <varchar> (Website) The website of the user.
fax	any <varchar> (Fax) The fax number of the user.
date_of_birth	any <varchar> (Date Of Birth) The date of birth of the user.
street	any <varchar> (Street) The street address of the user.
city	any <varchar> (City) The city of the user.
state	any <varchar> (State) The state of the user.
zip_code	any <varchar> (Zip Code) The zip code of the user.
country	any <varchar> (Country) The country of the user.
time_format	any <varchar> (Time Format) The time format of the user.
timezone	any <varchar> (Timezone) The timezone of the user.
signature	any <varchar> (Signature) The signature of the user.
data_source	any <char> (Data Source) The source of data for the user.

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"email": "[email protected]",
"user_type": "1",
"first_name": "John",
"last_name": "Doe",
"nationality": "US",
"username": "johndoe",
"status": "1",
"designation_id": "__test__sf5sukSOXduqmOY",
"alias": "johndoe",
"phone": "1234567890",
"mobile": "1234567890",
"website": "www.test.com",
"fax": "1234567890",
"date_of_birth": "2000-11-01",
"street": "123 Main St",
"city": "New York",
"state": "New York",
"zip_code": "12345",
"country": "US",
"time_format": "12",
"timezone": "America/New_York",
"signature": "John Doe",
"data_source": "System"
}

Get related list of Users

Returns one-to-many list of Users with related Module

path Parameters

user_id required	string The unique identifier of user
related required	varchar hasMany relation name

Responses

Response Schema: application/json

id	any <varchar> (Id) A unique and immutable identifier for the user.
email	any <varchar> (Email) The email address of the user.
user_type	any <varchar> (User Type) The type of the user. Possible values are `1` - The user is an admin. `2` - The user is a regular user.
first_name	any <varchar> (First Name) The first name of the user.
last_name	any <varchar> (Last Name) The last name of the user.
nationality	any <varchar> (Nationality) The nationality of the user.
username	any <varchar> (Username) The username of the user.
status	any <varchar> (Status) The status of the user. Possible values are `1` - The user is active. `0` - The user is inactive.
designation_id	any <varchar> (Designation Id) The identifier of the designation associated with the user.
alias	any <varchar> (Alias) The alias of the user.
phone	any <varchar> (Phone) The phone number of the user.
mobile	any <varchar> (Mobile) The mobile number of the user.
website	any <varchar> (Website) The website of the user.
fax	any <varchar> (Fax) The fax number of the user.
date_of_birth	any <varchar> (Date Of Birth) The date of birth of the user.
street	any <varchar> (Street) The street address of the user.
city	any <varchar> (City) The city of the user.
state	any <varchar> (State) The state of the user.
zip_code	any <varchar> (Zip Code) The zip code of the user.
country	any <varchar> (Country) The country of the user.
time_format	any <varchar> (Time Format) The time format of the user.
timezone	any <varchar> (Timezone) The timezone of the user.
signature	any <varchar> (Signature) The signature of the user.
data_source	any <char> (Data Source) The source of data for the user.

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"email": "[email protected]",
"user_type": "1",
"first_name": "John",
"last_name": "Doe",
"nationality": "US",
"username": "johndoe",
"status": "1",
"designation_id": "__test__sf5sukSOXduqmOY",
"alias": "johndoe",
"phone": "1234567890",
"mobile": "1234567890",
"website": "www.test.com",
"fax": "1234567890",
"date_of_birth": "2000-11-01",
"street": "123 Main St",
"city": "New York",
"state": "New York",
"zip_code": "12345",
"country": "US",
"time_format": "12",
"timezone": "America/New_York",
"signature": "John Doe",
"data_source": "System"
}

Get filtered list of Users

Search for users based on specific criteria or keywords. Use this endpoint to locate users that match given parameters or search terms.

path Parameters

fieldName

required

varchar

Field name to apply filter E.g. 'name' = 'John'

Responses

Response Schema: application/json

id	any <varchar> (Id) A unique and immutable identifier for the user.
email	any <varchar> (Email) The email address of the user.
user_type	any <varchar> (User Type) The type of the user. Possible values are `1` - The user is an admin. `2` - The user is a regular user.
first_name	any <varchar> (First Name) The first name of the user.
last_name	any <varchar> (Last Name) The last name of the user.
nationality	any <varchar> (Nationality) The nationality of the user.
username	any <varchar> (Username) The username of the user.
status	any <varchar> (Status) The status of the user. Possible values are `1` - The user is active. `0` - The user is inactive.
designation_id	any <varchar> (Designation Id) The identifier of the designation associated with the user.
alias	any <varchar> (Alias) The alias of the user.
phone	any <varchar> (Phone) The phone number of the user.
mobile	any <varchar> (Mobile) The mobile number of the user.
website	any <varchar> (Website) The website of the user.
fax	any <varchar> (Fax) The fax number of the user.
date_of_birth	any <varchar> (Date Of Birth) The date of birth of the user.
street	any <varchar> (Street) The street address of the user.
city	any <varchar> (City) The city of the user.
state	any <varchar> (State) The state of the user.
zip_code	any <varchar> (Zip Code) The zip code of the user.
country	any <varchar> (Country) The country of the user.
time_format	any <varchar> (Time Format) The time format of the user.
timezone	any <varchar> (Timezone) The timezone of the user.
signature	any <varchar> (Signature) The signature of the user.
data_source	any <char> (Data Source) The source of data for the user.

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"email": "[email protected]",
"user_type": "1",
"first_name": "John",
"last_name": "Doe",
"nationality": "US",
"username": "johndoe",
"status": "1",
"designation_id": "__test__sf5sukSOXduqmOY",
"alias": "johndoe",
"phone": "1234567890",
"mobile": "1234567890",
"website": "www.test.com",
"fax": "1234567890",
"date_of_birth": "2000-11-01",
"street": "123 Main St",
"city": "New York",
"state": "New York",
"zip_code": "12345",
"country": "US",
"time_format": "12",
"timezone": "America/New_York",
"signature": "John Doe",
"data_source": "System"
}

Filter User with nested conditions

Apply filters to narrow down the list of users based on various attributes. Use this endpoint to refine user searches by criteria such as role, status, or other parameters.

query Parameters

$equals	varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value'
$not_equals	varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value'
$starts	varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value'
$ends	varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value'
$contains	varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value'
$in	varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second']
$is_null	varchar Match if field have null value. E.g. filter[column_name][$is_null] = true
$not_null	varchar Match if field is not null. E.g. filter[column_name][$not_null] = true
$not_in	varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second']
$lt	varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value'
$lte	varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value'
$gt	varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value'
$gte	varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value'
$sortorder	varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc\|desc'
$limit	varchar Limit results E.g. filter[$limit] = '50' \| For offset: filter[$offset] = '20'
$paginate	varchar Paginate results E.g. filter[$paginate] = '50

Responses

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"email": "[email protected]",
"user_type": "1",
"first_name": "John",
"last_name": "Doe",
"nationality": "US",
"username": "johndoe",
"status": "1",
"designation_id": "__test__sf5sukSOXduqmOY",
"alias": "johndoe",
"phone": "1234567890",
"mobile": "1234567890",
"website": "www.test.com",
"fax": "1234567890",
"date_of_birth": "2000-11-01",
"street": "123 Main St",
"city": "New York",
"state": "New York",
"zip_code": "12345",
"country": "US",
"time_format": "12",
"timezone": "America/New_York",
"signature": "John Doe",
"data_source": "System"
}

Bulk destroy Users

Returns deleted Users data

query Parameters

ids

required

varchar

Array of ids to be deleted.

Responses

Response samples

Content type

application/json

{"id": "__test__sf5sukSOXduqmOY",
"email": "[email protected]",
"user_type": "1",
"first_name": "John",
"last_name": "Doe",
"nationality": "US",
"username": "johndoe",
"status": "1",
"designation_id": "__test__sf5sukSOXduqmOY",
"alias": "johndoe",
"phone": "1234567890",
"mobile": "1234567890",
"website": "www.test.com",
"fax": "1234567890",
"date_of_birth": "2000-11-01",
"street": "123 Main St",
"city": "New York",
"state": "New York",
"zip_code": "12345",
"country": "US",
"time_format": "12",
"timezone": "America/New_York",
"signature": "John Doe",
"data_source": "System"
}

CreditNotes

A credit note is a document that itemizes a customer's credit for products and services. It is generated at the end of a billing cycle, which can be monthly, quarterly, or yearly. The credit note details include the credit note ID, name, customer ID, credit note date, due date, total amount, and status.

Possible values for credit note status are

Allocated: The credit note is allocated.
Unallocated: The credit note is unallocated.
Partially Allocated: The credit note is partially allocated.
Cancelled: The credit note is cancelled.

Get list of CreditNotes

Retrieve a comprehensive list of all credit notes. This endpoint returns an overview of each credit note, including key details and statuses.

Responses

Response Schema: application/json

id	any <char> (Id) The unique identifier for the credit note.
name	any <varchar> (Name) The name of the credit note.
amount	any <double> (Amount) The amount of the credit note.
balance	any <varchar> (Balance) The balance of the credit note.
status	any <varchar> (Status) The status of the credit note. Possible values are: Allocated Unallocated
reference	any <varchar> (Reference) The reference of the credit note.
created_at	any <timestamp> (Created At) The date and time when the credit note was created.
updated_at	any <timestamp> (Updated At) The date and time when the credit note was last updated.
created_by	any <char> (Created By) The user who created the credit note.
updated_by	any <char> (Updated By) The user who last updated the credit note.
assigned_to	any <char> (Assigned To) The user who the credit note is assigned to.
data_source	any <char> (Data Source) The data source of the credit note.

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"name": "Acme Corp",
"amount": 100,
"balance": "100.00",
"status": "Unallocated",
"reference": "12345",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Store a new CreditNote

Create and save a new credit note in the system. Provide necessary credit note details in the request body to successfully record the new credit note.

Request Body schema: application/json
required

id	any <char> (Id) The unique identifier for the credit note.
name	any <varchar> (Name) The name of the credit note.
amount	any <double> (Amount) The amount of the credit note.
balance	any <varchar> (Balance) The balance of the credit note.
status	any <varchar> (Status) The status of the credit note. Possible values are: Allocated Unallocated
reference	any <varchar> (Reference) The reference of the credit note.
created_at	any <timestamp> (Created At) The date and time when the credit note was created.
updated_at	any <timestamp> (Updated At) The date and time when the credit note was last updated.
created_by	any <char> (Created By) The user who created the credit note.
updated_by	any <char> (Updated By) The user who last updated the credit note.
assigned_to	any <char> (Assigned To) The user who the credit note is assigned to.
data_source	any <char> (Data Source) The data source of the credit note.

Responses

Request samples

Payload

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"name": "Acme Corp",
"amount": 100,
"balance": "100.00",
"status": "Unallocated",
"reference": "12345",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"name": "Acme Corp",
"amount": 100,
"balance": "100.00",
"status": "Unallocated",
"reference": "12345",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Get CreditNote information

Retrieve detailed information about a specific credit note. This operation requires the credit note ID to fetch and display the relevant data.

path Parameters

credit-note

required

char

CreditNote id

Responses

Response Schema: application/json

id	any <char> (Id) The unique identifier for the credit note.
name	any <varchar> (Name) The name of the credit note.
amount	any <double> (Amount) The amount of the credit note.
balance	any <varchar> (Balance) The balance of the credit note.
status	any <varchar> (Status) The status of the credit note. Possible values are: Allocated Unallocated
reference	any <varchar> (Reference) The reference of the credit note.
created_at	any <timestamp> (Created At) The date and time when the credit note was created.
updated_at	any <timestamp> (Updated At) The date and time when the credit note was last updated.
created_by	any <char> (Created By) The user who created the credit note.
updated_by	any <char> (Updated By) The user who last updated the credit note.
assigned_to	any <char> (Assigned To) The user who the credit note is assigned to.
data_source	any <char> (Data Source) The data source of the credit note.

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"name": "Acme Corp",
"amount": 100,
"balance": "100.00",
"status": "Unallocated",
"reference": "12345",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Update existing CreditNote

Modify the details of an existing credit note. Provide the credit note ID and updated information in the request body to apply changes.

path Parameters

credit-note

required

char

CreditNote id

Request Body schema: application/json
required

id	any <char> (Id) The unique identifier for the credit note.
name	any <varchar> (Name) The name of the credit note.
amount	any <double> (Amount) The amount of the credit note.
balance	any <varchar> (Balance) The balance of the credit note.
status	any <varchar> (Status) The status of the credit note. Possible values are: Allocated Unallocated
reference	any <varchar> (Reference) The reference of the credit note.
created_at	any <timestamp> (Created At) The date and time when the credit note was created.
updated_at	any <timestamp> (Updated At) The date and time when the credit note was last updated.
created_by	any <char> (Created By) The user who created the credit note.
updated_by	any <char> (Updated By) The user who last updated the credit note.
assigned_to	any <char> (Assigned To) The user who the credit note is assigned to.
data_source	any <char> (Data Source) The data source of the credit note.

Responses

Response Schema: application/json

id	any <char> (Id) The unique identifier for the credit note.
name	any <varchar> (Name) The name of the credit note.
amount	any <double> (Amount) The amount of the credit note.
balance	any <varchar> (Balance) The balance of the credit note.
status	any <varchar> (Status) The status of the credit note. Possible values are: Allocated Unallocated
reference	any <varchar> (Reference) The reference of the credit note.
created_at	any <timestamp> (Created At) The date and time when the credit note was created.
updated_at	any <timestamp> (Updated At) The date and time when the credit note was last updated.
created_by	any <char> (Created By) The user who created the credit note.
updated_by	any <char> (Updated By) The user who last updated the credit note.
assigned_to	any <char> (Assigned To) The user who the credit note is assigned to.
data_source	any <char> (Data Source) The data source of the credit note.

Request samples

Payload

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"name": "Acme Corp",
"amount": 100,
"balance": "100.00",
"status": "Unallocated",
"reference": "12345",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"name": "Acme Corp",
"amount": 100,
"balance": "100.00",
"status": "Unallocated",
"reference": "12345",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Delete existing CreditNote

Permanently remove a specific credit note from the system. This operation requires the credit note ID to identify and delete the credit note.

path Parameters

credit-note

required

char

CreditNote id

Responses

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"name": "Acme Corp",
"amount": 100,
"balance": "100.00",
"status": "Unallocated",
"reference": "12345",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Get with-relations list of CreditNotes

Returns list of CreditNotes with all foreign keys

Responses

Response Schema: application/json

id	any <char> (Id) The unique identifier for the credit note.
name	any <varchar> (Name) The name of the credit note.
amount	any <double> (Amount) The amount of the credit note.
balance	any <varchar> (Balance) The balance of the credit note.
status	any <varchar> (Status) The status of the credit note. Possible values are: Allocated Unallocated
reference	any <varchar> (Reference) The reference of the credit note.
created_at	any <timestamp> (Created At) The date and time when the credit note was created.
updated_at	any <timestamp> (Updated At) The date and time when the credit note was last updated.
created_by	any <char> (Created By) The user who created the credit note.
updated_by	any <char> (Updated By) The user who last updated the credit note.
assigned_to	any <char> (Assigned To) The user who the credit note is assigned to.
data_source	any <char> (Data Source) The data source of the credit note.

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"name": "Acme Corp",
"amount": 100,
"balance": "100.00",
"status": "Unallocated",
"reference": "12345",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Get related list of CreditNotes

Returns one-to-many list of CreditNotes with related Module

path Parameters

id required	char CreditNote id
related required	varchar hasMany relation name

Responses

Response Schema: application/json

id	any <char> (Id) The unique identifier for the credit note.
name	any <varchar> (Name) The name of the credit note.
amount	any <double> (Amount) The amount of the credit note.
balance	any <varchar> (Balance) The balance of the credit note.
status	any <varchar> (Status) The status of the credit note. Possible values are: Allocated Unallocated
reference	any <varchar> (Reference) The reference of the credit note.
created_at	any <timestamp> (Created At) The date and time when the credit note was created.
updated_at	any <timestamp> (Updated At) The date and time when the credit note was last updated.
created_by	any <char> (Created By) The user who created the credit note.
updated_by	any <char> (Updated By) The user who last updated the credit note.
assigned_to	any <char> (Assigned To) The user who the credit note is assigned to.
data_source	any <char> (Data Source) The data source of the credit note.

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"name": "Acme Corp",
"amount": 100,
"balance": "100.00",
"status": "Unallocated",
"reference": "12345",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Get filtered list of CreditNotes

Search for credit notes based on specific criteria or filters. Use this endpoint to find credit notes that match given parameters, such as date range or status.

path Parameters

fieldName

required

varchar

Field name to apply filter E.g. 'name' = 'John'

Responses

Response Schema: application/json

id	any <char> (Id) The unique identifier for the credit note.
name	any <varchar> (Name) The name of the credit note.
amount	any <double> (Amount) The amount of the credit note.
balance	any <varchar> (Balance) The balance of the credit note.
status	any <varchar> (Status) The status of the credit note. Possible values are: Allocated Unallocated
reference	any <varchar> (Reference) The reference of the credit note.
created_at	any <timestamp> (Created At) The date and time when the credit note was created.
updated_at	any <timestamp> (Updated At) The date and time when the credit note was last updated.
created_by	any <char> (Created By) The user who created the credit note.
updated_by	any <char> (Updated By) The user who last updated the credit note.
assigned_to	any <char> (Assigned To) The user who the credit note is assigned to.
data_source	any <char> (Data Source) The data source of the credit note.

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"name": "Acme Corp",
"amount": 100,
"balance": "100.00",
"status": "Unallocated",
"reference": "12345",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Filter CreditNote with nested conditions

Returns filtered CreditNote data

query Parameters

$equals	varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value'
$not_equals	varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value'
$starts	varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value'
$ends	varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value'
$contains	varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value'
$in	varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second']
$is_null	varchar Match if field have null value. E.g. filter[column_name][$is_null] = true
$not_null	varchar Match if field is not null. E.g. filter[column_name][$not_null] = true
$not_in	varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second']
$lt	varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value'
$lte	varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value'
$gt	varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value'
$gte	varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value'
$sortorder	varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc\|desc'
$limit	varchar Limit results E.g. filter[$limit] = '50' \| For offset: filter[$offset] = '20'
$paginate	varchar Paginate results E.g. filter[$paginate] = '50

Responses

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"name": "Acme Corp",
"amount": 100,
"balance": "100.00",
"status": "Unallocated",
"reference": "12345",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

Bulk destroy CreditNotes

Returns deleted CreditNotes data

query Parameters

ids

required

varchar

Array of ids to be deleted.

Responses

Response samples

Content type

application/json

{"id": "__test__cs3VnHhSBWl7eY2bl",
"name": "Acme Corp",
"amount": 100,
"balance": "100.00",
"status": "Unallocated",
"reference": "12345",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"created_by": "__test__cs3VnHhSBWl7eY2bl",
"updated_by": "__test__cs3VnHhSBWl7eY2bl",
"assigned_to": "__test__cs3VnHhSBWl7eY2bl",
"data_source": "__test__cs3VnHhSBWl7eY2bl"
}

SubscriptionFlow API Reference (1.0.0)

Getting Started

Using Postman for API Testing

Authentication

Error Handling

The standard http status codes used are

Customers

Get list of Customers

Responses

Response Schema: application/json

Response samples

Store a new Customer

Responses

Response samples

Retrieve a Customer

path Parameters

Responses

Response Schema: application/json

Response samples

Update existing Customer

path Parameters

Request Body schema: application/json

Responses

Response Schema: application/json

Request samples

Response samples

Delete existing Customer

path Parameters

Responses

Response samples

Get with-relations list of Customers

Responses

Response Schema: application/json

Response samples

Get related list of Customers

path Parameters

Responses

Response Schema: application/json

Response samples

Get filtered list of Customers

path Parameters

Responses

Response Schema: application/json

Response samples

Filter Customer with nested conditions

query Parameters

Responses

Response samples

Bulk destroy Customers

query Parameters

Responses

Response samples

Get list of Email Addresses

Responses

Response Schema: application/json

Response samples

Store a new EmailAddress

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get EmailAddress information

path Parameters

Responses

Response Schema: application/json

Response samples

Update existing EmailAddress

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Delete existing EmailAddress

path Parameters

Responses

Response samples

Get with-relations list of Customers

Responses

Response Schema: application/json

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required