Download OpenAPI specification:Download
Developer reference for SubscriptionFlow API
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:
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.
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'
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.
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.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
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.
Array of objects | |
object | |
object |
{- "data": [
- {
- "id": "User-12345",
- "name": "SF DEVELOPERS",
- "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": {
}, - "meta": {
- "current_page": 0,
- "from": 0,
- "last_page": 0,
- "per_page": 0,
- "to": 0,
- "total": 0
}
}
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.
{- "data": {
- "type": "customers",
- "id": "3213427c-593d-458f-b18b-5562be90113d",
- "attributes": {
- "id": "3213427c-593d-458f-b18b-5562be90113d",
- "name": "Sybill",
- "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,
- "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",
}, - "tax_company": null,
- "assigned_group_id": null,
- "primary_churn_score_id": null
},
}
}
Retrieves the details of an existing customer. You need to pass the unique customer ID that was returned upon successful customer creation.
customer_id required | string The unique identifier for the customer. |
object |
{- "data": {
- "type": "customers",
- "id": "3213427c-593d-458f-b18b-5562be90113d",
- "attributes": {
- "id": "3213427c-593d-458f-b18b-5562be90113d",
- "name": "Sybill",
- "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,
- "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",
}, - "tax_company": null,
- "assigned_group_id": null,
- "primary_churn_score_id": null
},
}
}
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.
customer_id required | string The unique identifier for the customer. |
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. |
object |
{- "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.",
- "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_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"
}
{- "data": {
- "type": "customers",
- "id": "3213427c-593d-458f-b18b-5562be90113d",
- "attributes": {
- "id": "3213427c-593d-458f-b18b-5562be90113d",
- "name": "Sybill",
- "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,
- "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",
}, - "tax_company": null,
- "assigned_group_id": null,
- "primary_churn_score_id": null
},
}
}
Remove a specific customer from the database. This operation requires the customer ID to identify and delete the customer.
customer_id required | string The unique identifier for the customer. |
{- "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,
- "assigned_group_id": null,
- "primary_churn_score_id": {
- "id": "53300375-a94f-4dfa-a72a-b5d3dcb1089d",
- "link": "N/A"
}
},
}
Returns list of Customers with all foreign keys
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. |
{- "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.",
- "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_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"
}
Returns list of Customers with quick filters
fieldName required | varchar Field name to apply filter E.g. 'name' = 'John' |
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. |
{- "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.",
- "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_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"
}
Returns filtered Customer data
$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 |
{- "data": [
- {
- "id": "cus_OiMmx1XPUtvVcZ",
- "parent_id": null,
- "consolidate_invoices": null,
- "name": "abc sad",
- "company": null,
- "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
}
]
}
Returns deleted Customers data
ids required | varchar Array of ids to be deleted. |
{- "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.",
- "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_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"
}
Retrieve a list of all email addresses stored in the system. This endpoint returns an overview of each email address, including associated details.
any <varchar> (Email) | |
primary | any <tinyint> (Primary) primary |
invalid | any <tinyint> (Invalid) invalid |
opt_out | any <tinyint> (Opt Out) opt_out |
{- "email": "",
- "primary": "",
- "invalid": "",
- "opt_out": ""
}
Create and save a new email address in the system. Provide necessary details in the request body to successfully register the new email address.
any <varchar> (Email) | |
primary | any <tinyint> (Primary) primary |
invalid | any <tinyint> (Invalid) invalid |
opt_out | any <tinyint> (Opt Out) opt_out |
{- "email": "",
- "primary": "",
- "invalid": "",
- "opt_out": ""
}
{- "email": "",
- "primary": "",
- "invalid": "",
- "opt_out": ""
}
Retrieve detailed information about a specific email address. This operation requires the email address ID to fetch and display the relevant data.
email-address required | char EmailAddress id |
any <varchar> (Email) | |
primary | any <tinyint> (Primary) primary |
invalid | any <tinyint> (Invalid) invalid |
opt_out | any <tinyint> (Opt Out) opt_out |
{- "email": "",
- "primary": "",
- "invalid": "",
- "opt_out": ""
}
Modify the details of an existing email address. Provide the email address ID and updated information in the request body to apply changes.
email-address required | char EmailAddress id |
any <varchar> (Email) | |
primary | any <tinyint> (Primary) primary |
invalid | any <tinyint> (Invalid) invalid |
opt_out | any <tinyint> (Opt Out) opt_out |
any <varchar> (Email) | |
primary | any <tinyint> (Primary) primary |
invalid | any <tinyint> (Invalid) invalid |
opt_out | any <tinyint> (Opt Out) opt_out |
{- "email": "",
- "primary": "",
- "invalid": "",
- "opt_out": ""
}
{- "email": "",
- "primary": "",
- "invalid": "",
- "opt_out": ""
}
Permanently remove a specific email address from the system. This operation requires the email address ID to identify and delete the record.
email-address required | char EmailAddress id |
{- "email": "",
- "primary": "",
- "invalid": "",
- "opt_out": ""
}
Returns list of Customers with all foreign keys
any <varchar> (Email) | |
primary | any <tinyint> (Primary) primary |
invalid | any <tinyint> (Invalid) invalid |
opt_out | any <tinyint> (Opt Out) opt_out |
{- "email": "",
- "primary": "",
- "invalid": "",
- "opt_out": ""
}
Returns list of Customers with quick filters
fieldName required | varchar Field name to apply filter E.g. 'name' = 'John' |
any <varchar> (Email) | |
primary | any <tinyint> (Primary) primary |
invalid | any <tinyint> (Invalid) invalid |
opt_out | any <tinyint> (Opt Out) opt_out |
{- "email": "",
- "primary": "",
- "invalid": "",
- "opt_out": ""
}
Returns filtered EmailAddress data
$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 |
{- "email": "",
- "primary": "",
- "invalid": "",
- "opt_out": ""
}
A contact is a person associated with a customer. The contact details include the contact ID, name, email, phone, and status.
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.
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. |
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. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "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"
}
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.
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. |
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. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "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"
}
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "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"
}
Retrieves the details of an existing contact. You need to pass the unique contact ID that was returned upon successful contact creation.
contact required | char Contact id |
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. |
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. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "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"
}
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.
contact required | char Contact id |
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. |
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. |
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. |
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. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "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"
}
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "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"
}
Deletes a record and returns deleted record
contact required | char Contact id |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "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"
}
Returns list of Contacts with all foreign keys
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. |
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. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "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"
}
Returns list of Contacts with quick filters
fieldName required | varchar Field name to apply filter E.g. 'name' = 'John' |
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. |
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. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "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"
}
Returns filtered Contact data
$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 |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "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"
}
Returns deleted Contacts data
ids required | varchar Array of ids to be deleted. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "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"
}
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:
Retrieve a comprehensive list of all active subscriptions. This endpoint returns detailed information about each subscription.
Array of objects | |
object | |
object |
{- "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": {
- "prev": null,
- "next": null
}, - "meta": {
- "current_page": 1,
- "from": 1,
- "last_page": 1,
- "links": [
- {
- "url": null,
- "label": "« Previous",
- "active": false
}
], - "per_page": 200,
- "to": 3,
- "total": 3
}
}
Create and store a new subscription in the database for an existing customer in SubscriptionFlow. Provide necessary subscription details in the request body.
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_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
|
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
|
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.
|
status | any <varchar> (Status) The current state of the subscription (e.g., active, suspended). Possible values are
|
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
|
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. |
{- "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"
}
{- "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"
}
Retrieve detailed information about a specific subscription. This endpoint requires the subscription ID to fetch the relevant data.
subscription_id required | string The unique identifier of subscription |
object | |
object | |
object |
{- "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",
- "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",
- "created_by": {
- "id": "bed76993-640d-453a-ac4d-67c4a106ec48",
}, - "updated_by": {
- "id": "bed76993-640d-453a-ac4d-67c4a106ec48",
}, - "assigned_to": {
- "id": "bed76993-640d-453a-ac4d-67c4a106ec48",
}, - "assigned_group_id": null,
- "recipient_id": null,
- "tax_id": null
}
},
}
Modify the details of an existing subscription. Provide the subscription ID and updated information in the request body.
subscription_id required | string The unique identifier of subscription |
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_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
|
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
|
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.
|
status | any <varchar> (Status) The current state of the subscription (e.g., active, suspended). Possible values are
|
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
|
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. |
object | |
object | |
object |
{- "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"
}
{- "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",
- "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",
- "created_by": {
- "id": "bed76993-640d-453a-ac4d-67c4a106ec48",
}, - "updated_by": {
- "id": "bed76993-640d-453a-ac4d-67c4a106ec48",
}, - "assigned_to": {
- "id": "bed76993-640d-453a-ac4d-67c4a106ec48",
}, - "assigned_group_id": null,
- "recipient_id": null,
- "tax_id": null
}
},
}
Remove a specific subscription from the database. This operation requires the subscription ID to identify and delete the subscription.
subscription_id required | string The unique identifier of subscription |
{- "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",