SubscriptionFlow API Reference (1.0.0)

Download OpenAPI specification:Download

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

Developer reference for SubscriptionFlow API

Getting Started

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

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

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

Using Postman for API Testing

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

Open In Postman

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

Authentication

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

  1. 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.

  2. Obtain an Auth Token: Once you have your client_id and client_secret, make a POST request to the OAuth endpoint with these credentials to obtain a bearer token. Your request should include the following:

    • client_id: Your client ID.
    • client_secret: Your client secret.
    • Grant type: Use the "client_credentials" grant type to request an access token.

Example Request

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

Error Handling

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

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

The standard http status codes used are

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

Customers

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

Get list of Customers

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

Responses

Response Schema: application/json
id
any <char> (Id)

The unique identifier for the customer.

parent_id
any <char> (Parent Customer)

The identifier of the parent customer if applicable.

name
any <varchar> (Name)

The name of the customer.

phone_number
any <varchar> (Phone Number)

The customer's contact number.

po_number
any <varchar> (PO Number)

The customer's purchase order number.

legal_entity
any <varchar> (Legal Entity)

The legal entity associated with the customer.

billing_cycle_day
any <varchar> (Billing Cycle Day)

The day of the month when the customer's billing cycle starts.

notes
any <text> (Notes)

Additional information about the customer.

image
any <varchar> (Image)

The URL of an image for the customer.

customer_number
any <varchar> (Customer Number)

The customer's number or ID.

terms
any <varchar> (Terms)

The terms of payment for the customer.

created_at
any <timestamp> (Created At)

The date and time when the customer was created.

updated_at
any <timestamp> (Updated At)

The date and time when the customer was last updated.

deleted_at
any <timestamp> (Deleted At)

The date and time when the customer was deleted.

portal_pass
any <varchar> (Portal Pass)

The customer's portal password.

portal_email
any <varchar> (Portal Email)

The customer's portal email address.

portal_is_enabled
any <tinyint> (Portal Is Enabled)

Indicates whether the customer's portal is enabled.

last_successful_login
any <datetime> (Last Successful Login)

The date and time when the customer last logged in to the portal.

last_failed_login
any <datetime> (Last Failed Login)

The date and time when the customer last failed to log in to the portal.

tax_exempt
any <tinyint> (Tax Exempt)

Indicates whether the customer is exempt from tax.

certificate_id
any <varchar> (Certificate ID)

The customer's tax exemption certificate ID.

certificate_type
any <varchar> (Certificate Type)

The customer's tax exemption certificate type.

issuing_jurisdiction
any <varchar> (Issuing Jurisdiction)

The jurisdiction that issued the customer's tax exemption certificate.

entity_use_code
any <varchar> (Entity Use Code)

The customer's entity use code.

description
any <text> (Description)

The customer's description.

tax_company
any <char> (Tax Company)

The customer's tax company.

vat_id
any <varchar> (VAT ID)

The customer's VAT ID.

last_activity
any <varchar> (Last Activity)

The date and time when the customer was last active.

created_by
any <char> (Created By)

The user who created the customer.

updated_by
any <char> (Updated By)

The user who last updated the customer.

assigned_to
any <char> (Assigned To)

The user who is assigned to the customer.

assigned_group_id
any <char> (Assigned Group)

The group that is assigned to the customer.

auto_charge
any <tinyint> (Auto Charge)

Indicates whether the customer is automatically charged.

balance
any <number> (Outstanding Balance)

The customer's outstanding balance.

unapplied_amount
any <number> (Unapplied Amount)

The customer's unapplied amount.

billing_address_1
any <text> (Billing Address 1)

The customer's billing address line 1.

billing_address_2
any <text> (Billing Address 2)

The customer's billing address line 2.

billing_city
any <varchar> (Billing City)

The customer's billing address city.

billing_state
any <varchar> (Billing State)

The customer's billing address state.

billing_county
any <varchar> (Billing County)

The customer's billing address county.

billing_postal_code
any <varchar> (Billing Postal Code)

The customer's billing address postal code.

billing_country
any <varchar> (Billing Country)

The customer's billing address country.

shipping_address_1
any <text> (Shipping Address 1)

The customer's shipping address line 1.

shipping_address_2
any <text> (Shipping Address 2)

The customer's shipping address line 2.

shipping_city
any <varchar> (Shipping City)

The customer's shipping address city.

shipping_state
any <varchar> (Shipping State)

The customer's shipping address state.

shipping_county
any <varchar> (Shipping County)

The customer's shipping address county.

shipping_postal_code
any <varchar> (Shipping Postal Code)

The customer's shipping address postal code.

shipping_country
any <varchar> (Shipping Country)

The customer's shipping address country.

data_source
any <char> (Data Source)

The data source of the customer.

Response samples

Content type
application/json
{
}

Store a new Customer

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

Request Body schema: application/json
required
id
any <char> (Id)

The unique identifier for the customer.

parent_id
any <char> (Parent Customer)

The identifier of the parent customer if applicable.

name
any <varchar> (Name)

The name of the customer.

phone_number
any <varchar> (Phone Number)

The customer's contact number.

po_number
any <varchar> (PO Number)

The customer's purchase order number.

legal_entity
any <varchar> (Legal Entity)

The legal entity associated with the customer.

billing_cycle_day
any <varchar> (Billing Cycle Day)

The day of the month when the customer's billing cycle starts.

notes
any <text> (Notes)

Additional information about the customer.

image
any <varchar> (Image)

The URL of an image for the customer.

customer_number
any <varchar> (Customer Number)

The customer's number or ID.

terms
any <varchar> (Terms)

The terms of payment for the customer.

created_at
any <timestamp> (Created At)

The date and time when the customer was created.

updated_at
any <timestamp> (Updated At)

The date and time when the customer was last updated.

deleted_at
any <timestamp> (Deleted At)

The date and time when the customer was deleted.

portal_pass
any <varchar> (Portal Pass)

The customer's portal password.

portal_email
any <varchar> (Portal Email)

The customer's portal email address.

portal_is_enabled
any <tinyint> (Portal Is Enabled)

Indicates whether the customer's portal is enabled.

last_successful_login
any <datetime> (Last Successful Login)

The date and time when the customer last logged in to the portal.

last_failed_login
any <datetime> (Last Failed Login)

The date and time when the customer last failed to log in to the portal.

tax_exempt
any <tinyint> (Tax Exempt)

Indicates whether the customer is exempt from tax.

certificate_id
any <varchar> (Certificate ID)

The customer's tax exemption certificate ID.

certificate_type
any <varchar> (Certificate Type)

The customer's tax exemption certificate type.

issuing_jurisdiction
any <varchar> (Issuing Jurisdiction)

The jurisdiction that issued the customer's tax exemption certificate.

entity_use_code
any <varchar> (Entity Use Code)

The customer's entity use code.

description
any <text> (Description)

The customer's description.

tax_company
any <char> (Tax Company)

The customer's tax company.

vat_id
any <varchar> (VAT ID)

The customer's VAT ID.

last_activity
any <varchar> (Last Activity)

The date and time when the customer was last active.

created_by
any <char> (Created By)

The user who created the customer.

updated_by
any <char> (Updated By)

The user who last updated the customer.

assigned_to
any <char> (Assigned To)

The user who is assigned to the customer.

assigned_group_id
any <char> (Assigned Group)

The group that is assigned to the customer.

auto_charge
any <tinyint> (Auto Charge)

Indicates whether the customer is automatically charged.

balance
any <number> (Outstanding Balance)

The customer's outstanding balance.

unapplied_amount
any <number> (Unapplied Amount)

The customer's unapplied amount.

billing_address_1
any <text> (Billing Address 1)

The customer's billing address line 1.

billing_address_2
any <text> (Billing Address 2)

The customer's billing address line 2.

billing_city
any <varchar> (Billing City)

The customer's billing address city.

billing_state
any <varchar> (Billing State)

The customer's billing address state.

billing_county
any <varchar> (Billing County)

The customer's billing address county.

billing_postal_code
any <varchar> (Billing Postal Code)

The customer's billing address postal code.

billing_country
any <varchar> (Billing Country)

The customer's billing address country.

shipping_address_1
any <text> (Shipping Address 1)

The customer's shipping address line 1.

shipping_address_2
any <text> (Shipping Address 2)

The customer's shipping address line 2.

shipping_city
any <varchar> (Shipping City)

The customer's shipping address city.

shipping_state
any <varchar> (Shipping State)

The customer's shipping address state.

shipping_county
any <varchar> (Shipping County)

The customer's shipping address county.

shipping_postal_code
any <varchar> (Shipping Postal Code)

The customer's shipping address postal code.

shipping_country
any <varchar> (Shipping Country)

The customer's shipping address country.

data_source
any <char> (Data Source)

The data source of the customer.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Retrieve a Customer

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

path Parameters
customer
required
char

Customer id

Responses

Response Schema: application/json
id
any <char> (Id)

The unique identifier for the customer.

parent_id
any <char> (Parent Customer)

The identifier of the parent customer if applicable.

name
any <varchar> (Name)

The name of the customer.

phone_number
any <varchar> (Phone Number)

The customer's contact number.

po_number
any <varchar> (PO Number)

The customer's purchase order number.

legal_entity
any <varchar> (Legal Entity)

The legal entity associated with the customer.

billing_cycle_day
any <varchar> (Billing Cycle Day)

The day of the month when the customer's billing cycle starts.

notes
any <text> (Notes)

Additional information about the customer.

image
any <varchar> (Image)

The URL of an image for the customer.

customer_number
any <varchar> (Customer Number)

The customer's number or ID.

terms
any <varchar> (Terms)

The terms of payment for the customer.

created_at
any <timestamp> (Created At)

The date and time when the customer was created.

updated_at
any <timestamp> (Updated At)

The date and time when the customer was last updated.

deleted_at
any <timestamp> (Deleted At)

The date and time when the customer was deleted.

portal_pass
any <varchar> (Portal Pass)

The customer's portal password.

portal_email
any <varchar> (Portal Email)

The customer's portal email address.

portal_is_enabled
any <tinyint> (Portal Is Enabled)

Indicates whether the customer's portal is enabled.

last_successful_login
any <datetime> (Last Successful Login)

The date and time when the customer last logged in to the portal.

last_failed_login
any <datetime> (Last Failed Login)

The date and time when the customer last failed to log in to the portal.

tax_exempt
any <tinyint> (Tax Exempt)

Indicates whether the customer is exempt from tax.

certificate_id
any <varchar> (Certificate ID)

The customer's tax exemption certificate ID.

certificate_type
any <varchar> (Certificate Type)

The customer's tax exemption certificate type.

issuing_jurisdiction
any <varchar> (Issuing Jurisdiction)

The jurisdiction that issued the customer's tax exemption certificate.

entity_use_code
any <varchar> (Entity Use Code)

The customer's entity use code.

description
any <text> (Description)

The customer's description.

tax_company
any <char> (Tax Company)

The customer's tax company.

vat_id
any <varchar> (VAT ID)

The customer's VAT ID.

last_activity
any <varchar> (Last Activity)

The date and time when the customer was last active.

created_by
any <char> (Created By)

The user who created the customer.

updated_by
any <char> (Updated By)

The user who last updated the customer.

assigned_to
any <char> (Assigned To)

The user who is assigned to the customer.

assigned_group_id
any <char> (Assigned Group)

The group that is assigned to the customer.

auto_charge
any <tinyint> (Auto Charge)

Indicates whether the customer is automatically charged.

balance
any <number> (Outstanding Balance)

The customer's outstanding balance.

unapplied_amount
any <number> (Unapplied Amount)

The customer's unapplied amount.

billing_address_1
any <text> (Billing Address 1)

The customer's billing address line 1.

billing_address_2
any <text> (Billing Address 2)

The customer's billing address line 2.

billing_city
any <varchar> (Billing City)

The customer's billing address city.

billing_state
any <varchar> (Billing State)

The customer's billing address state.

billing_county
any <varchar> (Billing County)

The customer's billing address county.

billing_postal_code
any <varchar> (Billing Postal Code)

The customer's billing address postal code.

billing_country
any <varchar> (Billing Country)

The customer's billing address country.

shipping_address_1
any <text> (Shipping Address 1)

The customer's shipping address line 1.

shipping_address_2
any <text> (Shipping Address 2)

The customer's shipping address line 2.

shipping_city
any <varchar> (Shipping City)

The customer's shipping address city.

shipping_state
any <varchar> (Shipping State)

The customer's shipping address state.

shipping_county
any <varchar> (Shipping County)

The customer's shipping address county.

shipping_postal_code
any <varchar> (Shipping Postal Code)

The customer's shipping address postal code.

shipping_country
any <varchar> (Shipping Country)

The customer's shipping address country.

data_source
any <char> (Data Source)

The data source of the customer.

Response samples

Content type
application/json
{
}

Update existing Customer

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

path Parameters
customer
required
char

Customer id

Request Body schema: application/json
required
id
any <char> (Id)

The unique identifier for the customer.

parent_id
any <char> (Parent Customer)

The identifier of the parent customer if applicable.

name
any <varchar> (Name)

The name of the customer.

phone_number
any <varchar> (Phone Number)

The customer's contact number.

po_number
any <varchar> (PO Number)

The customer's purchase order number.

legal_entity
any <varchar> (Legal Entity)

The legal entity associated with the customer.

billing_cycle_day
any <varchar> (Billing Cycle Day)

The day of the month when the customer's billing cycle starts.

notes
any <text> (Notes)

Additional information about the customer.

image
any <varchar> (Image)

The URL of an image for the customer.

customer_number
any <varchar> (Customer Number)

The customer's number or ID.

terms
any <varchar> (Terms)

The terms of payment for the customer.

created_at
any <timestamp> (Created At)

The date and time when the customer was created.

updated_at
any <timestamp> (Updated At)

The date and time when the customer was last updated.

deleted_at
any <timestamp> (Deleted At)

The date and time when the customer was deleted.

portal_pass
any <varchar> (Portal Pass)

The customer's portal password.

portal_email
any <varchar> (Portal Email)

The customer's portal email address.

portal_is_enabled
any <tinyint> (Portal Is Enabled)

Indicates whether the customer's portal is enabled.

last_successful_login
any <datetime> (Last Successful Login)

The date and time when the customer last logged in to the portal.

last_failed_login
any <datetime> (Last Failed Login)

The date and time when the customer last failed to log in to the portal.

tax_exempt
any <tinyint> (Tax Exempt)

Indicates whether the customer is exempt from tax.

certificate_id
any <varchar> (Certificate ID)

The customer's tax exemption certificate ID.

certificate_type
any <varchar> (Certificate Type)

The customer's tax exemption certificate type.

issuing_jurisdiction
any <varchar> (Issuing Jurisdiction)

The jurisdiction that issued the customer's tax exemption certificate.

entity_use_code
any <varchar> (Entity Use Code)

The customer's entity use code.

description
any <text> (Description)

The customer's description.

tax_company
any <char> (Tax Company)

The customer's tax company.

vat_id
any <varchar> (VAT ID)

The customer's VAT ID.

last_activity
any <varchar> (Last Activity)

The date and time when the customer was last active.

created_by
any <char> (Created By)

The user who created the customer.

updated_by
any <char> (Updated By)

The user who last updated the customer.

assigned_to
any <char> (Assigned To)

The user who is assigned to the customer.

assigned_group_id
any <char> (Assigned Group)

The group that is assigned to the customer.

auto_charge
any <tinyint> (Auto Charge)

Indicates whether the customer is automatically charged.

balance
any <number> (Outstanding Balance)

The customer's outstanding balance.

unapplied_amount
any <number> (Unapplied Amount)

The customer's unapplied amount.

billing_address_1
any <text> (Billing Address 1)

The customer's billing address line 1.

billing_address_2
any <text> (Billing Address 2)

The customer's billing address line 2.

billing_city
any <varchar> (Billing City)

The customer's billing address city.

billing_state
any <varchar> (Billing State)

The customer's billing address state.

billing_county
any <varchar> (Billing County)

The customer's billing address county.

billing_postal_code
any <varchar> (Billing Postal Code)

The customer's billing address postal code.

billing_country
any <varchar> (Billing Country)

The customer's billing address country.

shipping_address_1
any <text> (Shipping Address 1)

The customer's shipping address line 1.

shipping_address_2
any <text> (Shipping Address 2)

The customer's shipping address line 2.

shipping_city
any <varchar> (Shipping City)

The customer's shipping address city.

shipping_state
any <varchar> (Shipping State)

The customer's shipping address state.

shipping_county
any <varchar> (Shipping County)

The customer's shipping address county.

shipping_postal_code
any <varchar> (Shipping Postal Code)

The customer's shipping address postal code.

shipping_country
any <varchar> (Shipping Country)

The customer's shipping address country.

data_source
any <char> (Data Source)

The data source of the customer.

Responses

Response Schema: application/json
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.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete existing Customer

Deletes a record and returns deleted record

path Parameters
customer
required
char

Customer id

Responses

Response samples

Content type
application/json
{
}

Get with-relations list of Customers

Returns list of Customers with all foreign keys

Responses

Response Schema: application/json
id
any <char> (Id)

The unique identifier for the customer.

parent_id
any <char> (Parent Customer)

The identifier of the parent customer if applicable.

name
any <varchar> (Name)

The name of the customer.

phone_number
any <varchar> (Phone Number)

The customer's contact number.

po_number
any <varchar> (PO Number)

The customer's purchase order number.

legal_entity
any <varchar> (Legal Entity)

The legal entity associated with the customer.

billing_cycle_day
any <varchar> (Billing Cycle Day)

The day of the month when the customer's billing cycle starts.

notes
any <text> (Notes)

Additional information about the customer.

image
any <varchar> (Image)

The URL of an image for the customer.

customer_number
any <varchar> (Customer Number)

The customer's number or ID.

terms
any <varchar> (Terms)

The terms of payment for the customer.

created_at
any <timestamp> (Created At)

The date and time when the customer was created.

updated_at
any <timestamp> (Updated At)

The date and time when the customer was last updated.

deleted_at
any <timestamp> (Deleted At)

The date and time when the customer was deleted.

portal_pass
any <varchar> (Portal Pass)

The customer's portal password.

portal_email
any <varchar> (Portal Email)

The customer's portal email address.

portal_is_enabled
any <tinyint> (Portal Is Enabled)

Indicates whether the customer's portal is enabled.

last_successful_login
any <datetime> (Last Successful Login)

The date and time when the customer last logged in to the portal.

last_failed_login
any <datetime> (Last Failed Login)

The date and time when the customer last failed to log in to the portal.

tax_exempt
any <tinyint> (Tax Exempt)

Indicates whether the customer is exempt from tax.

certificate_id
any <varchar> (Certificate ID)

The customer's tax exemption certificate ID.

certificate_type
any <varchar> (Certificate Type)

The customer's tax exemption certificate type.

issuing_jurisdiction
any <varchar> (Issuing Jurisdiction)

The jurisdiction that issued the customer's tax exemption certificate.

entity_use_code
any <varchar> (Entity Use Code)

The customer's entity use code.

description
any <text> (Description)

The customer's description.

tax_company
any <char> (Tax Company)

The customer's tax company.

vat_id
any <varchar> (VAT ID)

The customer's VAT ID.

last_activity
any <varchar> (Last Activity)

The date and time when the customer was last active.

created_by
any <char> (Created By)

The user who created the customer.

updated_by
any <char> (Updated By)

The user who last updated the customer.

assigned_to
any <char> (Assigned To)

The user who is assigned to the customer.

assigned_group_id
any <char> (Assigned Group)

The group that is assigned to the customer.

auto_charge
any <tinyint> (Auto Charge)

Indicates whether the customer is automatically charged.

balance
any <number> (Outstanding Balance)

The customer's outstanding balance.

unapplied_amount
any <number> (Unapplied Amount)

The customer's unapplied amount.

billing_address_1
any <text> (Billing Address 1)

The customer's billing address line 1.

billing_address_2
any <text> (Billing Address 2)

The customer's billing address line 2.

billing_city
any <varchar> (Billing City)

The customer's billing address city.

billing_state
any <varchar> (Billing State)

The customer's billing address state.

billing_county
any <varchar> (Billing County)

The customer's billing address county.

billing_postal_code
any <varchar> (Billing Postal Code)

The customer's billing address postal code.

billing_country
any <varchar> (Billing Country)

The customer's billing address country.

shipping_address_1
any <text> (Shipping Address 1)

The customer's shipping address line 1.

shipping_address_2
any <text> (Shipping Address 2)

The customer's shipping address line 2.

shipping_city
any <varchar> (Shipping City)

The customer's shipping address city.

shipping_state
any <varchar> (Shipping State)

The customer's shipping address state.

shipping_county
any <varchar> (Shipping County)

The customer's shipping address county.

shipping_postal_code
any <varchar> (Shipping Postal Code)

The customer's shipping address postal code.

shipping_country
any <varchar> (Shipping Country)

The customer's shipping address country.

data_source
any <char> (Data Source)

The data source of the customer.

Response samples

Content type
application/json
{
}

Get related list of Customers

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

path Parameters
id
required
char

Customer id

related
required
varchar

hasMany relation name

Responses

Response Schema: application/json
id
any <char> (Id)

The unique identifier for the customer.

parent_id
any <char> (Parent Customer)

The identifier of the parent customer if applicable.

name
any <varchar> (Name)

The name of the customer.

phone_number
any <varchar> (Phone Number)

The customer's contact number.

po_number
any <varchar> (PO Number)

The customer's purchase order number.

legal_entity
any <varchar> (Legal Entity)

The legal entity associated with the customer.

billing_cycle_day
any <varchar> (Billing Cycle Day)

The day of the month when the customer's billing cycle starts.

notes
any <text> (Notes)

Additional information about the customer.

image
any <varchar> (Image)

The URL of an image for the customer.

customer_number
any <varchar> (Customer Number)

The customer's number or ID.

terms
any <varchar> (Terms)

The terms of payment for the customer.

created_at
any <timestamp> (Created At)

The date and time when the customer was created.

updated_at
any <timestamp> (Updated At)

The date and time when the customer was last updated.

deleted_at
any <timestamp> (Deleted At)

The date and time when the customer was deleted.

portal_pass
any <varchar> (Portal Pass)

The customer's portal password.

portal_email
any <varchar> (Portal Email)

The customer's portal email address.

portal_is_enabled
any <tinyint> (Portal Is Enabled)

Indicates whether the customer's portal is enabled.

last_successful_login
any <datetime> (Last Successful Login)

The date and time when the customer last logged in to the portal.

last_failed_login
any <datetime> (Last Failed Login)

The date and time when the customer last failed to log in to the portal.

tax_exempt
any <tinyint> (Tax Exempt)

Indicates whether the customer is exempt from tax.

certificate_id
any <varchar> (Certificate ID)

The customer's tax exemption certificate ID.

certificate_type
any <varchar> (Certificate Type)

The customer's tax exemption certificate type.

issuing_jurisdiction
any <varchar> (Issuing Jurisdiction)

The jurisdiction that issued the customer's tax exemption certificate.

entity_use_code
any <varchar> (Entity Use Code)

The customer's entity use code.

description
any <text> (Description)

The customer's description.

tax_company
any <char> (Tax Company)

The customer's tax company.

vat_id
any <varchar> (VAT ID)

The customer's VAT ID.

last_activity
any <varchar> (Last Activity)

The date and time when the customer was last active.

created_by
any <char> (Created By)

The user who created the customer.

updated_by
any <char> (Updated By)

The user who last updated the customer.

assigned_to
any <char> (Assigned To)

The user who is assigned to the customer.

assigned_group_id
any <char> (Assigned Group)

The group that is assigned to the customer.

auto_charge
any <tinyint> (Auto Charge)

Indicates whether the customer is automatically charged.

balance
any <number> (Outstanding Balance)

The customer's outstanding balance.

unapplied_amount
any <number> (Unapplied Amount)

The customer's unapplied amount.

billing_address_1
any <text> (Billing Address 1)

The customer's billing address line 1.

billing_address_2
any <text> (Billing Address 2)

The customer's billing address line 2.

billing_city
any <varchar> (Billing City)

The customer's billing address city.

billing_state
any <varchar> (Billing State)

The customer's billing address state.

billing_county
any <varchar> (Billing County)

The customer's billing address county.

billing_postal_code
any <varchar> (Billing Postal Code)

The customer's billing address postal code.

billing_country
any <varchar> (Billing Country)

The customer's billing address country.

shipping_address_1
any <text> (Shipping Address 1)

The customer's shipping address line 1.

shipping_address_2
any <text> (Shipping Address 2)

The customer's shipping address line 2.

shipping_city
any <varchar> (Shipping City)

The customer's shipping address city.

shipping_state
any <varchar> (Shipping State)

The customer's shipping address state.

shipping_county
any <varchar> (Shipping County)

The customer's shipping address county.

shipping_postal_code
any <varchar> (Shipping Postal Code)

The customer's shipping address postal code.

shipping_country
any <varchar> (Shipping Country)

The customer's shipping address country.

data_source
any <char> (Data Source)

The data source of the customer.

Response samples

Content type
application/json
{
}

Get filtered list of Customers

Returns list of Customers with quick filters

path Parameters
fieldName
required
varchar

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

Responses

Response Schema: application/json
id
any <char> (Id)

The unique identifier for the customer.

parent_id
any <char> (Parent Customer)

The identifier of the parent customer if applicable.

name
any <varchar> (Name)

The name of the customer.

phone_number
any <varchar> (Phone Number)

The customer's contact number.

po_number
any <varchar> (PO Number)

The customer's purchase order number.

legal_entity
any <varchar> (Legal Entity)

The legal entity associated with the customer.

billing_cycle_day
any <varchar> (Billing Cycle Day)

The day of the month when the customer's billing cycle starts.

notes
any <text> (Notes)

Additional information about the customer.

image
any <varchar> (Image)

The URL of an image for the customer.

customer_number
any <varchar> (Customer Number)

The customer's number or ID.

terms
any <varchar> (Terms)

The terms of payment for the customer.

created_at
any <timestamp> (Created At)

The date and time when the customer was created.

updated_at
any <timestamp> (Updated At)

The date and time when the customer was last updated.

deleted_at
any <timestamp> (Deleted At)

The date and time when the customer was deleted.

portal_pass
any <varchar> (Portal Pass)

The customer's portal password.

portal_email
any <varchar> (Portal Email)

The customer's portal email address.

portal_is_enabled
any <tinyint> (Portal Is Enabled)

Indicates whether the customer's portal is enabled.

last_successful_login
any <datetime> (Last Successful Login)

The date and time when the customer last logged in to the portal.

last_failed_login
any <datetime> (Last Failed Login)

The date and time when the customer last failed to log in to the portal.

tax_exempt
any <tinyint> (Tax Exempt)

Indicates whether the customer is exempt from tax.

certificate_id
any <varchar> (Certificate ID)

The customer's tax exemption certificate ID.

certificate_type
any <varchar> (Certificate Type)

The customer's tax exemption certificate type.

issuing_jurisdiction
any <varchar> (Issuing Jurisdiction)

The jurisdiction that issued the customer's tax exemption certificate.

entity_use_code
any <varchar> (Entity Use Code)

The customer's entity use code.

description
any <text> (Description)

The customer's description.

tax_company
any <char> (Tax Company)

The customer's tax company.

vat_id
any <varchar> (VAT ID)

The customer's VAT ID.

last_activity
any <varchar> (Last Activity)

The date and time when the customer was last active.

created_by
any <char> (Created By)

The user who created the customer.

updated_by
any <char> (Updated By)

The user who last updated the customer.

assigned_to
any <char> (Assigned To)

The user who is assigned to the customer.

assigned_group_id
any <char> (Assigned Group)

The group that is assigned to the customer.

auto_charge
any <tinyint> (Auto Charge)

Indicates whether the customer is automatically charged.

balance
any <number> (Outstanding Balance)

The customer's outstanding balance.

unapplied_amount
any <number> (Unapplied Amount)

The customer's unapplied amount.

billing_address_1
any <text> (Billing Address 1)

The customer's billing address line 1.

billing_address_2
any <text> (Billing Address 2)

The customer's billing address line 2.

billing_city
any <varchar> (Billing City)

The customer's billing address city.

billing_state
any <varchar> (Billing State)

The customer's billing address state.

billing_county
any <varchar> (Billing County)

The customer's billing address county.

billing_postal_code
any <varchar> (Billing Postal Code)

The customer's billing address postal code.

billing_country
any <varchar> (Billing Country)

The customer's billing address country.

shipping_address_1
any <text> (Shipping Address 1)

The customer's shipping address line 1.

shipping_address_2
any <text> (Shipping Address 2)

The customer's shipping address line 2.

shipping_city
any <varchar> (Shipping City)

The customer's shipping address city.

shipping_state
any <varchar> (Shipping State)

The customer's shipping address state.

shipping_county
any <varchar> (Shipping County)

The customer's shipping address county.

shipping_postal_code
any <varchar> (Shipping Postal Code)

The customer's shipping address postal code.

shipping_country
any <varchar> (Shipping Country)

The customer's shipping address country.

data_source
any <char> (Data Source)

The data source of the customer.

Response samples

Content type
application/json
{
}

Filter Customer with nested conditions

Returns filtered Customer data

query Parameters
$equals
varchar

Equals field-value. E.g. filter[column_name][$equals] = 'some_value'

$not_equals
varchar

Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value'

$starts
varchar

Match value starts with. E.g. filter[column_name][$starts] = 'some_value'

$ends
varchar

Match value ends with. E.g. filter[column_name][$ends] = 'some_value'

$contains
varchar

Match if field contains value. E.g. filter[column_name][$contains] = 'some_value'

$in
varchar

Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second']

$is_null
varchar

Match if field have null value. E.g. filter[column_name][$is_null] = true

$not_null
varchar

Match if field is not null. E.g. filter[column_name][$not_null] = true

$not_in
varchar

Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second']

$lt
varchar

Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value'

$lte
varchar

Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value'

$gt
varchar

Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value'

$gte
varchar

Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value'

$sortorder
varchar

Sort results asc/desc E.g. filter[$sortorder] = 'asc|desc'

$limit
varchar

Limit results E.g. filter[$limit] = '50' | For offset: filter[$offset] = '20'

$paginate
varchar

Paginate results E.g. filter[$paginate] = '50

Responses

Response samples

Content type
application/json
{
}

Bulk destroy Customers

Returns deleted Customers data

query Parameters
ids
required
varchar

Array of ids to be deleted.

Responses

Response samples

Content type
application/json
{
}

Get list of Customers

Returns list of Customers

Responses

Response Schema: application/json
email
any <varchar> (Email)

email

primary
any <tinyint> (Primary)

primary

invalid
any <tinyint> (Invalid)

invalid

opt_out
any <tinyint> (Opt Out)

opt_out

Response samples

Content type
application/json
{
}

Store a new EmailAddress

Returns EmailAddress data

Request Body schema: application/json
required
email
any <varchar> (Email)

email

primary
any <tinyint> (Primary)

primary

invalid
any <tinyint> (Invalid)

invalid

opt_out
any <tinyint> (Opt Out)

opt_out

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get EmailAddress information

Returns EmailAddress data

path Parameters
email-address
required
char

EmailAddress id

Responses

Response Schema: application/json
email
any <varchar> (Email)

email

primary
any <tinyint> (Primary)

primary

invalid
any <tinyint> (Invalid)

invalid

opt_out
any <tinyint> (Opt Out)

opt_out

Response samples

Content type
application/json
{
}

Update existing EmailAddress

Returns updated EmailAddress data

path Parameters
email-address
required
char

EmailAddress id

Request Body schema: application/json
required
email
any <varchar> (Email)

email

primary
any <tinyint> (Primary)

primary

invalid
any <tinyint> (Invalid)

invalid

opt_out
any <tinyint> (Opt Out)

opt_out

Responses

Response Schema: application/json
email
any <varchar> (Email)

email

primary
any <tinyint> (Primary)

primary

invalid
any <tinyint> (Invalid)

invalid

opt_out
any <tinyint> (Opt Out)

opt_out

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete existing EmailAddress

Deletes a record and returns deleted record

path Parameters
email-address
required
char

EmailAddress id

Responses

Response samples

Content type
application/json
{
}

Get with-relations list of Customers

Returns list of Customers with all foreign keys

Responses

Response Schema: application/json
email
any <varchar> (Email)

email

primary
any <tinyint> (Primary)

primary

invalid
any <tinyint> (Invalid)

invalid

opt_out
any <tinyint> (Opt Out)

opt_out

Response samples

Content type
application/json
{
}

Get related list of Customers

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

path Parameters
id
required
char

EmailAddress id

related
required
varchar

hasMany relation name

Responses

Response Schema: application/json
email
any <varchar> (Email)

email

primary
any <tinyint> (Primary)

primary

invalid
any <tinyint> (Invalid)

invalid

opt_out
any <tinyint> (Opt Out)

opt_out

Response samples

Content type
application/json
{
}

Get filtered list of Customers

Returns list of Customers with quick filters

path Parameters
fieldName
required
varchar

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

Responses

Response Schema: application/json
email
any <varchar> (Email)

email

primary
any <tinyint> (Primary)

primary

invalid
any <tinyint> (Invalid)

invalid

opt_out
any <tinyint> (Opt Out)

opt_out

Response samples

Content type
application/json
{
}

Filter EmailAddress with nested conditions

Returns filtered EmailAddress data

query Parameters
$equals
varchar

Equals field-value. E.g. filter[column_name][$equals] = 'some_value'

$not_equals
varchar

Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value'

$starts
varchar

Match value starts with. E.g. filter[column_name][$starts] = 'some_value'

$ends
varchar

Match value ends with. E.g. filter[column_name][$ends] = 'some_value'

$contains
varchar

Match if field contains value. E.g. filter[column_name][$contains] = 'some_value'

$in
varchar

Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second']

$is_null
varchar

Match if field have null value. E.g. filter[column_name][$is_null] = true

$not_null
varchar

Match if field is not null. E.g. filter[column_name][$not_null] = true

$not_in
varchar

Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second']

$lt
varchar

Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value'

$lte
varchar

Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value'

$gt
varchar

Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value'

$gte
varchar

Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value'

$sortorder
varchar

Sort results asc/desc E.g. filter[$sortorder] = 'asc|desc'

$limit
varchar

Limit results E.g. filter[$limit] = '50' | For offset: filter[$offset] = '20'

$paginate
varchar

Paginate results E.g. filter[$paginate] = '50

Responses

Response samples

Content type
application/json
{
}

Bulk destroy Customers

Returns deleted Customers data

query Parameters
ids
required
varchar

Array of ids to be deleted.

Responses

Response samples

Content type
application/json
{
}

Contacts

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

Get list of Contacts

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

Responses

Response Schema: application/json
id
any <char> (Id)

The unique identifier for the contact.

customer_id
any <char> (Customer)

The identifier of the customer.

salutation
any <varchar> (Salutation)

The salutation of the contact.

first_name
any <varchar> (First Name)

The first name of the contact.

last_name
any <varchar> (Last Name)

The last name of the contact.

name
any <varchar> (Name)

The name of the contact.

email
any <varchar> (Email)

The email address of the contact.

work_phone
any <varchar> (Work Phone)

The work phone number of the contact.

personal_phone
any <varchar> (Personal Phone)

The personal phone number of the contact.

home_phone
any <varchar> (Home Phone)

The home phone number of the contact.

other_phone
any <varchar> (Other Phone)

The other phone number of the contact.

fax
any <varchar> (Fax)

The fax number of the contact.

description
any <text> (Description)

The description of the contact.

is_primary
any <tinyint> (Is Primary)

The primary contact of the customer.

created_at
any <timestamp> (Created At)

The date and time when the contact was created.

updated_at
any <timestamp> (Updated At)

The date and time when the contact was last updated.

created_by
any <char> (Created By)

The user who created the contact.

updated_by
any <char> (Updated By)

The user who last updated the contact.

assigned_to
any <char> (Assigned To)

The user who the contact is assigned to.

assigned_group_id
any <char> (Assigned Group)

The identifier of the group who the contact is assigned to.

billing_address_1
any <text> (Billing Address 1)

The billing address of the contact.

billing_address_2
any <text> (Billing Address 2)

The billing address of the contact.

billing_city
any <varchar> (Billing City)

The billing city of the contact.

billing_state
any <varchar> (Billing State)

The billing state of the contact.

billing_county
any <varchar> (Billing County)

The billing county of the contact.

billing_postal_code
any <varchar> (Billing Postal Code)

The billing postal code of the contact.

billing_country
any <varchar> (Billing Country)

The billing country of the contact.

shipping_address_1
any <text> (Shipping Address 1)

The shipping address of the contact.

shipping_address_2
any <text> (Shipping Address 2)

The shipping address of the contact.

shipping_city
any <contacts> (Shipping City)

The shipping city of the contact.

shipping_state
any <varchar> (Shipping State)

The shipping state of the contact.

shipping_county
any <varchar> (Shipping County)

The shipping county of the contact.

shipping_postal_code
any <contacts> (Shipping Postal Code)

The shipping postal code of the contact.

shipping_country
any <varchar> (Shipping Country)

The shipping country of the contact.

data_source
any <char> (Data Source)

The data source of the contact.

Response samples

Content type
application/json
{
}

Store a new Contact

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

Request Body schema: application/json
required
id
any <char> (Id)

The unique identifier for the contact.

customer_id
any <char> (Customer)

The identifier of the customer.

salutation
any <varchar> (Salutation)

The salutation of the contact.

first_name
any <varchar> (First Name)

The first name of the contact.

last_name
any <varchar> (Last Name)

The last name of the contact.

name
any <varchar> (Name)

The name of the contact.

email
any <varchar> (Email)

The email address of the contact.

work_phone
any <varchar> (Work Phone)

The work phone number of the contact.

personal_phone
any <varchar> (Personal Phone)

The personal phone number of the contact.

home_phone
any <varchar> (Home Phone)

The home phone number of the contact.

other_phone
any <varchar> (Other Phone)

The other phone number of the contact.

fax
any <varchar> (Fax)

The fax number of the contact.

description
any <text> (Description)

The description of the contact.

is_primary
any <tinyint> (Is Primary)

The primary contact of the customer.

created_at
any <timestamp> (Created At)

The date and time when the contact was created.

updated_at
any <timestamp> (Updated At)

The date and time when the contact was last updated.

created_by
any <char> (Created By)

The user who created the contact.

updated_by
any <char> (Updated By)

The user who last updated the contact.

assigned_to
any <char> (Assigned To)

The user who the contact is assigned to.

assigned_group_id
any <char> (Assigned Group)

The identifier of the group who the contact is assigned to.

billing_address_1
any <text> (Billing Address 1)

The billing address of the contact.

billing_address_2
any <text> (Billing Address 2)

The billing address of the contact.

billing_city
any <varchar> (Billing City)

The billing city of the contact.

billing_state
any <varchar> (Billing State)

The billing state of the contact.

billing_county
any <varchar> (Billing County)

The billing county of the contact.

billing_postal_code
any <varchar> (Billing Postal Code)

The billing postal code of the contact.

billing_country
any <varchar> (Billing Country)

The billing country of the contact.

shipping_address_1
any <text> (Shipping Address 1)

The shipping address of the contact.

shipping_address_2
any <text> (Shipping Address 2)

The shipping address of the contact.

shipping_city
any <contacts> (Shipping City)

The shipping city of the contact.

shipping_state
any <varchar> (Shipping State)

The shipping state of the contact.

shipping_county
any <varchar> (Shipping County)

The shipping county of the contact.

shipping_postal_code
any <contacts> (Shipping Postal Code)

The shipping postal code of the contact.

shipping_country
any <varchar> (Shipping Country)

The shipping country of the contact.

data_source
any <char> (Data Source)

The data source of the contact.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get Contact information

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

path Parameters
contact
required
char

Contact id

Responses

Response Schema: application/json
id
any <char> (Id)

The unique identifier for the contact.

customer_id
any <char> (Customer)

The identifier of the customer.

salutation
any <varchar> (Salutation)

The salutation of the contact.

first_name
any <varchar> (First Name)

The first name of the contact.

last_name
any <varchar> (Last Name)

The last name of the contact.

name
any <varchar> (Name)

The name of the contact.

email
any <varchar> (Email)

The email address of the contact.

work_phone
any <varchar> (Work Phone)

The work phone number of the contact.

personal_phone
any <varchar> (Personal Phone)

The personal phone number of the contact.

home_phone
any <varchar> (Home Phone)

The home phone number of the contact.

other_phone
any <varchar> (Other Phone)

The other phone number of the contact.

fax
any <varchar> (Fax)

The fax number of the contact.

description
any <text> (Description)

The description of the contact.

is_primary
any <tinyint> (Is Primary)

The primary contact of the customer.

created_at
any <timestamp> (Created At)

The date and time when the contact was created.

updated_at
any <timestamp> (Updated At)

The date and time when the contact was last updated.

created_by
any <char> (Created By)

The user who created the contact.

updated_by
any <char> (Updated By)

The user who last updated the contact.

assigned_to
any <char> (Assigned To)

The user who the contact is assigned to.

assigned_group_id
any <char> (Assigned Group)

The identifier of the group who the contact is assigned to.

billing_address_1
any <text> (Billing Address 1)

The billing address of the contact.

billing_address_2
any <text> (Billing Address 2)

The billing address of the contact.

billing_city
any <varchar> (Billing City)

The billing city of the contact.

billing_state
any <varchar> (Billing State)

The billing state of the contact.

billing_county
any <varchar> (Billing County)

The billing county of the contact.

billing_postal_code
any <varchar> (Billing Postal Code)

The billing postal code of the contact.

billing_country
any <varchar> (Billing Country)

The billing country of the contact.

shipping_address_1
any <text> (Shipping Address 1)

The shipping address of the contact.

shipping_address_2
any <text> (Shipping Address 2)

The shipping address of the contact.

shipping_city
any <contacts> (Shipping City)

The shipping city of the contact.

shipping_state
any <varchar> (Shipping State)

The shipping state of the contact.

shipping_county
any <varchar> (Shipping County)

The shipping county of the contact.

shipping_postal_code
any <contacts> (Shipping Postal Code)

The shipping postal code of the contact.

shipping_country
any <varchar> (Shipping Country)

The shipping country of the contact.

data_source
any <char> (Data Source)

The data source of the contact.

Response samples

Content type
application/json
{
}

Update existing Contact

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

path Parameters
contact
required
char

Contact id

Request Body schema: application/json
required
id
any <char> (Id)

The unique identifier for the contact.

customer_id
any <char> (Customer)

The identifier of the customer.

salutation
any <varchar> (Salutation)

The salutation of the contact.

first_name
any <varchar> (First Name)

The first name of the contact.

last_name
any <varchar> (Last Name)

The last name of the contact.

name
any <varchar> (Name)

The name of the contact.

email
any <varchar> (Email)

The email address of the contact.

work_phone
any <varchar> (Work Phone)

The work phone number of the contact.

personal_phone
any <varchar> (Personal Phone)

The personal phone number of the contact.

home_phone
any <varchar> (Home Phone)

The home phone number of the contact.

other_phone
any <varchar> (Other Phone)

The other phone number of the contact.

fax
any <varchar> (Fax)

The fax number of the contact.

description
any <text> (Description)

The description of the contact.

is_primary
any <tinyint> (Is Primary)

The primary contact of the customer.

created_at
any <timestamp> (Created At)

The date and time when the contact was created.

updated_at
any <timestamp> (Updated At)

The date and time when the contact was last updated.

created_by
any <char> (Created By)

The user who created the contact.

updated_by
any <char> (Updated By)

The user who last updated the contact.

assigned_to
any <char> (Assigned To)

The user who the contact is assigned to.

assigned_group_id
any <char> (Assigned Group)

The identifier of the group who the contact is assigned to.

billing_address_1
any <text> (Billing Address 1)

The billing address of the contact.

billing_address_2
any <text> (Billing Address 2)

The billing address of the contact.

billing_city
any <varchar> (Billing City)

The billing city of the contact.

billing_state
any <varchar> (Billing State)

The billing state of the contact.

billing_county
any <varchar> (Billing County)

The billing county of the contact.

billing_postal_code
any <varchar> (Billing Postal Code)

The billing postal code of the contact.

billing_country
any <varchar> (Billing Country)

The billing country of the contact.

shipping_address_1
any <text> (Shipping Address 1)

The shipping address of the contact.

shipping_address_2
any <text> (Shipping Address 2)

The shipping address of the contact.

shipping_city
any <contacts> (Shipping City)

The shipping city of the contact.

shipping_state
any <varchar> (Shipping State)

The shipping state of the contact.

shipping_county
any <varchar> (Shipping County)

The shipping county of the contact.

shipping_postal_code
any <contacts> (Shipping Postal Code)

The shipping postal code of the contact.

shipping_country
any <varchar> (Shipping Country)

The shipping country of the contact.

data_source
any <char> (Data Source)

The data source of the contact.

Responses

Response Schema: application/json
id
any <char> (Id)

The unique identifier for the contact.

customer_id
any <char> (Customer)

The identifier of the customer.

salutation
any <varchar> (Salutation)

The salutation of the contact.

first_name
any <varchar> (First Name)

The first name of the contact.

last_name
any <varchar> (Last Name)

The last name of the contact.

name
any <varchar> (Name)

The name of the contact.

email
any <varchar> (Email)

The email address of the contact.

work_phone
any <varchar> (Work Phone)

The work phone number of the contact.

personal_phone
any <varchar> (Personal Phone)

The personal phone number of the contact.

home_phone
any <varchar> (Home Phone)

The home phone number of the contact.

other_phone
any <varchar> (Other Phone)

The other phone number of the contact.

fax
any <varchar> (Fax)

The fax number of the contact.

description
any <text> (Description)

The description of the contact.

is_primary
any <tinyint> (Is Primary)

The primary contact of the customer.

created_at
any <timestamp> (Created At)

The date and time when the contact was created.

updated_at
any <timestamp> (Updated At)

The date and time when the contact was last updated.

created_by
any <char> (Created By)

The user who created the contact.

updated_by
any <char> (Updated By)

The user who last updated the contact.

assigned_to
any <char> (Assigned To)

The user who the contact is assigned to.

assigned_group_id
any <char> (Assigned Group)

The identifier of the group who the contact is assigned to.

billing_address_1
any <text> (Billing Address 1)

The billing address of the contact.

billing_address_2
any <text> (Billing Address 2)

The billing address of the contact.

billing_city
any <varchar> (Billing City)

The billing city of the contact.

billing_state
any <varchar> (Billing State)

The billing state of the contact.

billing_county
any <varchar> (Billing County)

The billing county of the contact.

billing_postal_code
any <varchar> (Billing Postal Code)

The billing postal code of the contact.

billing_country
any <varchar> (Billing Country)

The billing country of the contact.

shipping_address_1
any <text> (Shipping Address 1)

The shipping address of the contact.

shipping_address_2
any <text> (Shipping Address 2)

The shipping address of the contact.

shipping_city
any <contacts> (Shipping City)

The shipping city of the contact.

shipping_state
any <varchar> (Shipping State)

The shipping state of the contact.

shipping_county
any <varchar> (Shipping County)

The shipping county of the contact.

shipping_postal_code
any <contacts> (Shipping Postal Code)

The shipping postal code of the contact.

shipping_country
any <varchar> (Shipping Country)

The shipping country of the contact.

data_source
any <char> (Data Source)

The data source of the contact.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete existing Contact

Deletes a record and returns deleted record

path Parameters
contact
required
char

Contact id

Responses

Response samples

Content type
application/json
{
}

Get with-relations list of Contacts

Returns list of Contacts with all foreign keys

Responses

Response Schema: application/json
id
any <char> (Id)

The unique identifier for the contact.

customer_id
any <char> (Customer)

The identifier of the customer.

salutation
any <varchar> (Salutation)

The salutation of the contact.

first_name
any <varchar> (First Name)

The first name of the contact.

last_name
any <varchar> (Last Name)

The last name of the contact.

name
any <varchar> (Name)

The name of the contact.

email
any <varchar> (Email)

The email address of the contact.

work_phone
any <varchar> (Work Phone)

The work phone number of the contact.

personal_phone
any <varchar> (Personal Phone)

The personal phone number of the contact.

home_phone
any <varchar> (Home Phone)

The home phone number of the contact.

other_phone
any <varchar> (Other Phone)

The other phone number of the contact.

fax
any <varchar> (Fax)

The fax number of the contact.

description
any <text> (Description)

The description of the contact.

is_primary
any <tinyint> (Is Primary)

The primary contact of the customer.

created_at
any <timestamp> (Created At)

The date and time when the contact was created.

updated_at
any <timestamp> (Updated At)

The date and time when the contact was last updated.

created_by
any <char> (Created By)

The user who created the contact.

updated_by
any <char> (Updated By)

The user who last updated the contact.

assigned_to
any <char> (Assigned To)

The user who the contact is assigned to.

assigned_group_id
any <char> (Assigned Group)

The identifier of the group who the contact is assigned to.

billing_address_1
any <text> (Billing Address 1)

The billing address of the contact.

billing_address_2
any <text> (Billing Address 2)

The billing address of the contact.

billing_city
any <varchar> (Billing City)

The billing city of the contact.

billing_state
any <varchar> (Billing State)

The billing state of the contact.

billing_county
any <varchar> (Billing County)

The billing county of the contact.

billing_postal_code
any <varchar> (Billing Postal Code)

The billing postal code of the contact.

billing_country
any <varchar> (Billing Country)

The billing country of the contact.

shipping_address_1
any <text> (Shipping Address 1)

The shipping address of the contact.

shipping_address_2
any <text> (Shipping Address 2)

The shipping address of the contact.

shipping_city
any <contacts> (Shipping City)

The shipping city of the contact.

shipping_state
any <varchar> (Shipping State)

The shipping state of the contact.

shipping_county
any <varchar> (Shipping County)

The shipping county of the contact.

shipping_postal_code
any <contacts> (Shipping Postal Code)

The shipping postal code of the contact.

shipping_country
any <varchar> (Shipping Country)

The shipping country of the contact.

data_source
any <char> (Data Source)

The data source of the contact.

Response samples

Content type
application/json
{
}

Get related list of Contacts

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

path Parameters
id
required
char

Contact id

related
required
varchar

hasMany relation name

Responses

Response Schema: application/json
id
any <char> (Id)

The unique identifier for the contact.

customer_id
any <char> (Customer)

The identifier of the customer.

salutation
any <varchar> (Salutation)

The salutation of the contact.

first_name
any <varchar> (First Name)

The first name of the contact.

last_name
any <varchar> (Last Name)

The last name of the contact.

name
any <varchar> (Name)

The name of the contact.

email
any <varchar> (Email)

The email address of the contact.

work_phone
any <varchar> (Work Phone)

The work phone number of the contact.

personal_phone
any <varchar> (Personal Phone)

The personal phone number of the contact.

home_phone
any <varchar> (Home Phone)

The home phone number of the contact.

other_phone
any <varchar> (Other Phone)

The other phone number of the contact.

fax
any <varchar> (Fax)

The fax number of the contact.

description
any <text> (Description)

The description of the contact.

is_primary
any <tinyint> (Is Primary)

The primary contact of the customer.

created_at
any <timestamp> (Created At)

The date and time when the contact was created.

updated_at
any <timestamp> (Updated At)

The date and time when the contact was last updated.

created_by
any <char> (Created By)

The user who created the contact.

updated_by
any <char> (Updated By)

The user who last updated the contact.

assigned_to
any <char> (Assigned To)

The user who the contact is assigned to.

assigned_group_id
any <char> (Assigned Group)

The identifier of the group who the contact is assigned to.

billing_address_1
any <text> (Billing Address 1)

The billing address of the contact.

billing_address_2
any <text> (Billing Address 2)

The billing address of the contact.

billing_city
any <varchar> (Billing City)

The billing city of the contact.

billing_state
any <varchar> (Billing State)

The billing state of the contact.

billing_county
any <varchar> (Billing County)

The billing county of the contact.

billing_postal_code
any <varchar> (Billing Postal Code)

The billing postal code of the contact.

billing_country
any <varchar> (Billing Country)

The billing country of the contact.

shipping_address_1
any <text> (Shipping Address 1)

The shipping address of the contact.

shipping_address_2
any <text> (Shipping Address 2)

The shipping address of the contact.

shipping_city
any <contacts> (Shipping City)

The shipping city of the contact.

shipping_state
any <varchar> (Shipping State)

The shipping state of the contact.

shipping_county
any <varchar> (Shipping County)

The shipping county of the contact.

shipping_postal_code
any <contacts> (Shipping Postal Code)

The shipping postal code of the contact.

shipping_country
any <varchar> (Shipping Country)

The shipping country of the contact.

data_source
any <char> (Data Source)

The data source of the contact.

Response samples

Content type
application/json
{
}

Get filtered list of Contacts

Returns list of Contacts with quick filters

path Parameters
fieldName
required
varchar

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

Responses

Response Schema: application/json
id
any <char> (Id)

The unique identifier for the contact.

customer_id
any <char> (Customer)

The identifier of the customer.

salutation
any <varchar> (Salutation)

The salutation of the contact.

first_name
any <varchar> (First Name)

The first name of the contact.

last_name
any <varchar> (Last Name)

The last name of the contact.

name
any <varchar> (Name)

The name of the contact.

email
any <varchar> (Email)

The email address of the contact.

work_phone
any <varchar> (Work Phone)

The work phone number of the contact.

personal_phone
any <varchar> (Personal Phone)

The personal phone number of the contact.

home_phone
any <varchar> (Home Phone)

The home phone number of the contact.

other_phone
any <varchar> (Other Phone)

The other phone number of the contact.

fax
any <varchar> (Fax)

The fax number of the contact.

description
any <text> (Description)

The description of the contact.

is_primary
any <tinyint> (Is Primary)

The primary contact of the customer.

created_at
any <timestamp> (Created At)

The date and time when the contact was created.

updated_at
any <timestamp> (Updated At)

The date and time when the contact was last updated.

created_by
any <char> (Created By)

The user who created the contact.

updated_by
any <char> (Updated By)

The user who last updated the contact.

assigned_to
any <char> (Assigned To)

The user who the contact is assigned to.

assigned_group_id
any <char> (Assigned Group)

The identifier of the group who the contact is assigned to.

billing_address_1
any <text> (Billing Address 1)

The billing address of the contact.

billing_address_2
any <text> (Billing Address 2)

The billing address of the contact.

billing_city
any <varchar> (Billing City)

The billing city of the contact.

billing_state
any <varchar> (Billing State)

The billing state of the contact.

billing_county
any <varchar> (Billing County)

The billing county of the contact.

billing_postal_code
any <varchar> (Billing Postal Code)

The billing postal code of the contact.

billing_country
any <varchar> (Billing Country)

The billing country of the contact.

shipping_address_1
any <text> (Shipping Address 1)

The shipping address of the contact.

shipping_address_2
any <text> (Shipping Address 2)

The shipping address of the contact.

shipping_city
any <contacts> (Shipping City)

The shipping city of the contact.

shipping_state
any <varchar> (Shipping State)

The shipping state of the contact.

shipping_county
any <varchar> (Shipping County)

The shipping county of the contact.

shipping_postal_code
any <contacts> (Shipping Postal Code)

The shipping postal code of the contact.

shipping_country
any <varchar> (Shipping Country)

The shipping country of the contact.

data_source
any <char> (Data Source)

The data source of the contact.

Response samples

Content type
application/json
{
}

Filter Contact with nested conditions

Returns filtered Contact data

query Parameters
$equals
varchar

Equals field-value. E.g. filter[column_name][$equals] = 'some_value'

$not_equals
varchar

Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value'

$starts
varchar

Match value starts with. E.g. filter[column_name][$starts] = 'some_value'

$ends
varchar

Match value ends with. E.g. filter[column_name][$ends] = 'some_value'

$contains
varchar

Match if field contains value. E.g. filter[column_name][$contains] = 'some_value'

$in
varchar

Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second']

$is_null
varchar

Match if field have null value. E.g. filter[column_name][$is_null] = true

$not_null
varchar

Match if field is not null. E.g. filter[column_name][$not_null] = true

$not_in
varchar

Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second']

$lt
varchar

Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value'

$lte
varchar

Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value'

$gt
varchar

Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value'

$gte
varchar

Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value'

$sortorder
varchar

Sort results asc/desc E.g. filter[$sortorder] = 'asc|desc'

$limit
varchar

Limit results E.g. filter[$limit] = '50' | For offset: filter[$offset] = '20'

$paginate
varchar

Paginate results E.g. filter[$paginate] = '50

Responses

Response samples

Content type
application/json
{
}

Bulk destroy Contacts

Returns deleted Contacts data

query Parameters
ids
required
varchar

Array of ids to be deleted.

Responses

Response samples

Content type
application/json
{
}

Subscriptions

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

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

Get list of Subscriptions

Returns a list of subscriptions meeting all the conditions specified in the filter parameters below.

Responses

Response Schema: application/json
id
any <varchar> (Id)

A unique and immutable identifier for the subscription.

customer_id
any <char> (Customer)

Identifier of the customer with whom this subscription is associated.

items
any <array> (Items)

Identifier of the plan and product with whom this subscription is associated.

name
any <varchar> (Name)

The name associated with this subscription.

type
any <varchar> (Type)

The type or category of the subscription.

Possible values are

  • Termed
  • Evergreen
termed_start_date
any <date> (Term Start Date)

The date when the subscription's term starts.

termed_initial_period
any <int> (Term Initial Period)

The initial period of the subscription term.

termed_initial_period_type
any <varchar> (Term Initial Period Type)

The type or unit of the initial period.

Possible values are

  • month
  • week
  • year
  • day
renewal_type
any <varchar> (Renewal Type)

The type of renewal for the subscription.

renewal_period
any <int> (Renewal Period)

The renewal period duration.

renewal_period_type
any <varchar> (Renewal Period Type)

The type or unit of the renewal period.

Possible values are

  • month
  • week
  • year
  • day
is_auto_renew
any <tinyint> (Is Auto Renew)

Indicates whether the subscription auto-renews (1 for yes, 0 for no).

trigger_dates
any <date> (Trigger Dates)

Dates or events that trigger actions related to the subscription.

invoice_separate
any <date> (Invoice the Subscription Separately)

Indicates if the subscription is separately invoiced (1 for yes, 0 for no).

total_amount
any <double> (Total Amount)

The total amount associated with the subscription's plan-items.

Note: The total_amount value would be 0 (zero) if subscription "type" is evergreen

status
any <varchar> (Status)

The current state of the subscription (e.g., active, suspended).

Possible values are

  1. active

    The subscription is active and in service.

  2. pending

    The subscription is pending activation.

  3. draft

    The subscription is in draft mode.

  4. trial

    The subscription is in trial mode.

  5. suspended

    The subscription is suspended. The subscription will not renew while in this state.

  6. cancelled

    The subscription has been canceled and is no longer in service.

  7. expired

    The subscription has expired and is no longer in service.

payment_status
any <varchar> (Payment Status)

The payment status of the subscription (e.g., pending, paid).

created_at
any <timestamp> (Created At)

The date and time when the subscription was created.

suspended_at
any <timestamp> (Suspended At)

The date and time when the subscription was suspended.

cancelled_at
any <timestamp> (Cancelled At)

The date and time when the subscription was cancelled.

billing_end_date
any <date> (Billing End Date)

The date when billing for the subscription ends.

updated_at
any <timestamp> (Updated At)

The date and time when the subscription was last updated.

created_by
any <char> (Created By)

The identifier of the user who created the subscription.

updated_by
any <char> (Updated By)

The identifier of the user who last updated the subscription.

assigned_to
any <char> (Assigned To)

The identifier of the user to whom the subscription is assigned.

assigned_group_id
any <char> (Assigned Group)

The identifier of the group to which the subscription is assigned.

data_source
any <char> (Data Source)

The source of data for the subscription.

trial_period
any <int> (Trial Period)

The duration of the trial period.

trial_period_unit
any <varchar> (Trial Period Unit)

The unit of the trial period duration.

Possible values are

  • days
  • months
is_gift
any <tinyint> (Gift Subscription)

Indicates if the subscription is a gift (1 for yes, 0 for no).

recipient_id
any <char> (Gift Recipient)

The identifier of the recipient of the gift subscription.

Response samples

Content type
application/json