Billing
Handle platform subscription
It manages various aspects of billing and subscriptions. It includes verify coupon validity, create, retrieve, and cancel subscription charges, manage one-time charges, access and manage invoices, work with customer details, and interact with subscription plans, allowing you to retrieve details, manage features, activate or cancel plans, access enterprise plans, and update plan statuses as needed.
Operations
GET
# Obtain charge details
GET
# Retrieve subscription charge details
POST
# Cancel the extension subscription
POST
# Generate a one-time charge
POST
# Initiate subscription billing
Parameters
company_id
string
Required
The unique identifier of the company.
extension_id
string
Required
The unique identifier of the extension
charge_id
string
Required
The unique identifier of the entity charge in the system.
Response
200
404
The request was successfully processed
ChargeDetails
_id
string
Unique identifier for the charge.
entity_type
string
Specifies the type of entity related to the operation, such as 'extension' or 'subscription'
Enum
entity_id
string
Unique identifier for the entity (eg. extension)
name
string
The name of the extension plan
term
string
Description of the charge term.
charge_type
string
The type of charge (e.g., 'standalone', 'recurring').
Enum
pricing_type
string
The pricing model for the charge (e.g., 'one_time', 'recurring').
Enum
price
object (EntityChargePrice)
EntityChargePrice
amount
number
| value >= 1
The amount for the price. The minimum value is 1.
currency_code
string
The currency code for the price
recurring
object (ChargeRecurring)
ChargeRecurring
interval
string
The interval at which the recurring charge is applied. Examples include "month", "year", etc.
Enum
interval_time
number
status
string
Current status of the charge.
Enum
capped_amount
number
The maximum amount that can be charged for a particular service or item
activated_on
string
| date-time
Date and time when the charge was activated.
cancelled_on
string
| date-time
Date and time when the charge was cancelled.
billing_date
string
| date-time
The date when the billing occurred. This field is optional and may be null if the billing date is not specified.
current_period
object (SubscriptionTrialPeriod)
SubscriptionTrialPeriod
start_date
string
| date-time
The start date and time of the trial period.
end_date
string
| date-time
The end date and time of the trial period.
modified_at
string
| date-time
Date and time when the charge details were last modified.
created_at
string
| date-time
Date and time when the charge was created.
is_test
boolean
Indicates whether the operation or data is in a test mode.
company_id
string
The unique identifier of the company.
meta
object
Additional metadata associated with the charge.
__v
number
Internal version key for the charge record.
Examples
Parameters
company_id:
"20"
extension_id:
"64b0dff8c35f99051888085c"
charge_id:
"64b54e711c0570666d5612bb"
Was this section helpful?
GET
Response
Retrieve detailed information about subscription charges using this API.
Parameters
company_id
string
Required
The unique identifier of the company.
extension_id
string
Required
The unique identifier of the extension
subscription_id
string
Required
The unique identifier of the subscription
Response
200
404
The request was successfully processed
SubscriptionChargeRes
_id
string
Unique identifier for the subscription charge
product_suit_id
string
A unique identifier for a product suite, which represents a specific collection or group of products within the system.
entity_id
string
Unique identifier for the entity (eg. extension)
entity_type
string
Specifies the type of entity related to the operation, such as 'extension' or 'subscription'
Enum
name
string
The name of the extension plan
status
string
Current status of the extension subscription
Enum
trial_days
number
The number of days allocated for the trial period
activated_on
string
| date-time
Date when the charge was activated
cancelled_on
string
| date-time
Date when the charge was cancelled
is_test
boolean
Indicates whether the operation or data is in a test mode.
created_at
string
| date-time
Timestamp when the charge was created
modified_at
string
| date-time
Timestamp when the charge was last modified
company_id
string
The unique identifier of the company.
line_items
array of object
List of line items associated with the charge
Examples
Parameters
company_id:
"20"
extension_id:
"64b0dff8c35f99051888085c"
subscription_id:
"6606ab6d89fdb100d0f39e99"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
The unique identifier of the company.
extension_id
string
Required
The unique identifier of the extension
subscription_id
string
Required
The unique identifier of the subscription
Response
200
404
The request was successfully processed
SubscriptionChargeRes
_id
string
Unique identifier for the subscription charge
product_suit_id
string
A unique identifier for a product suite, which represents a specific collection or group of products within the system.
entity_id
string
Unique identifier for the entity (eg. extension)
entity_type
string
Specifies the type of entity related to the operation, such as 'extension' or 'subscription'
Enum
name
string
The name of the extension plan
status
string
Current status of the extension subscription
Enum
trial_days
number
The number of days allocated for the trial period
activated_on
string
| date-time
Date when the charge was activated
cancelled_on
string
| date-time
Date when the charge was cancelled
is_test
boolean
Indicates whether the operation or data is in a test mode.
created_at
string
| date-time
Timestamp when the charge was created
modified_at
string
| date-time
Timestamp when the charge was last modified
company_id
string
The unique identifier of the company.
line_items
array of object
List of line items associated with the charge
Examples
Parameters
company_id:
"20"
extension_id:
"64b0dff8c35f99051888085c"
subscription_id:
"6606ab6d89fdb100d0f39e99"
Was this section helpful?
POST
Response
Parameters
company_id
string
Required
The unique identifier of the company.
extension_id
string
Required
The unique identifier of the extension
Request body
name
string
The name of the one-time charge to be created.
charge
object (OneTimeChargeItem)
OneTimeChargeItem
name
string
The name of the one-time charge item.
term
string
The term or description of the charge.
pricing_type
string
The type of pricing for the charge item.
Enum
price
object (EntityChargePrice)
EntityChargePrice
amount
number
| value >= 1
The amount for the price. The minimum value is 1.
currency_code
string
The currency code for the price
capped_amount
number
The maximum amount that can be charged for a particular service or item
is_test
boolean
Indicates whether the operation or data is in a test mode.
metadata
object
Additional metadata associated with the charge item.
is_test
boolean
Indicates whether the operation or data is in a test mode.
return_url
string
URL to which the user will be redirected after creating the charge.
Response
200
400
The request was successfully processed
CreateOneTimeChargeResponseSchemas
charge
object (Charge)
Charge
final_charge
object (OneTimeChargeEntity)
OneTimeChargeEntity
term
string
Description of the charge term or usage.
charge_type
string
Type of the charge (e.g., 'subscription', 'extension').
Enum
capped_amount
number
The maximum amount that can be charged for a particular service or item
billing_date
string
| date-time
Nullable
The date when the billing occurred. This field is optional and may be null if the billing date is not specified.
created_at
string
| date-time
Date and time when the charge entity was created.
modified_at
string
| date-time
Date and time when the charge entity was last modified.
__v
number
Internal version key for the charge record.
_id
string
Unique identifier for the charge entity.
name
string
The name of the one-time charge.
status
string
Current status of the charge (e.g., 'pending').
Enum
activated_on
string
| date-time
Nullable
Date and time when the charge was activated. Null if not yet activated.
cancelled_on
string
| date-time
Nullable
Date and time when the charge was cancelled. Null if not cancelled.
metadata
object
Additional metadata associated with the charge.
return_url
string
URL to redirect to after processing the charge.
is_test
boolean
Indicates whether the operation or data is in a test mode.
pricing_type
string
Pricing model for the charge (e.g., 'one_time').
Enum
subscriber_id
string
The unique identifier for the company in the system.
entity_type
string
Specifies the type of entity related to the operation, such as 'extension' or 'subscription'
Enum
entity_id
string
Unique identifier for the entity (eg. extension)
meta
object
Additional metadata associated with the charge.
price
object (EntityChargePrice)
EntityChargePrice
amount
number
| value >= 1
The amount for the price. The minimum value is 1.
currency_code
string
The currency code for the price
confirm_url
string
URL to which users are redirected to confirm or complete the payment or subscription process.
Examples
Parameters
company_id:
"20"
extension_id:
"64b54e711c0570321b5612ad"
body:
body
Was this section helpful?
POST
Response
Initiates and registers a subscription charge for a specific extension for a given company.
Parameters
company_id
integer
Required
The unique identifier of the company.
extension_id
string
Required
The unique identifier of the extension
Request body
name
string
Required
The name of the extension plan
trial_days
number
The number of days allocated for the trial period
line_items
array of object (ChargeLineItem)
Required
Array of ChargeLineItem
name
string
Required
Its name of the extension plan.
term
string
Required
It indicates how it will be charged.
pricing_type
string
Required
Specifies the type of pricing for the extension subscription. It indicates whether the subscription will be automatically renewed, charged once, or based on usage.
Enum
price
object (EntityChargePrice)
Required
EntityChargePrice
amount
number
| value >= 1
The amount for the price. The minimum value is 1.
currency_code
string
The currency code for the price
recurring
object (EntityChargeRecurring)
EntityChargeRecurring
interval
string
Required
The interval at which the recurring charge is applied. Examples include "month", "year", etc.
Enum
capped_amount
number
The maximum amount that can be charged for a particular service or item
trial_days
number
The number of days allocated for the trial period
is_test
boolean
Indicates whether the operation or data is in a test mode.
metadata
object
is_test
boolean
Indicates whether the operation or data is in a test mode.
return_url
string
Required
The URL to which the user will be redirected after the subscription process is complete.
Response
200
400
The request was successfully processed
CreateSubscription
subscription
object (EntitySubscription)
EntitySubscription
_id
string
Unique identifier for the subscription charge
product_suit_id
string
A unique identifier for a product suite, which represents a specific collection or group of products within the system.
entity_id
string
Unique identifier for the entity (eg. extension)
entity_type
string
Specifies the type of entity related to the operation, such as 'extension' or 'subscription'
Enum
name
string
The name of the extension plan
status
string
Current status of the subscription charge
Enum
trial_days
number
The number of days allocated for the trial period
is_test
boolean
Indicates whether the operation or data is in a test mode.
created_at
string
| date-time
Timestamp when the charge was created
modified_at
string
| date-time
Timestamp when the charge was last modified
subscriber_id
string
The unique identifier for the company in the system.
line_items
array of object (EntityChargeDetails)
Array of EntityChargeDetails
_id
string
The unique identifier for the charge.
subscription_id
string
The unique identifier of the subscription.
subscriber_id
string
The unique identifier for the company in the system.
entity_type
string
Specifies the type of entity related to the operation, such as 'extension' or 'subscription'
Enum
entity_id
string
Unique identifier for the entity (eg. extension)
name
string
The name of the extension plan
term
string
Detailed description of the terms and conditions associated with the charge.
charge_type
string
The type of charge (e.g., 'standalone', 'recurring').
Enum
pricing_type
string
The pricing model for the charge (e.g., 'one_time', 'recurring').
Enum
price
object (EntityChargePrice)
EntityChargePrice
amount
number
| value >= 1
The amount for the price. The minimum value is 1.
currency_code
string
The currency code for the price
recurring
object (ChargeRecurring)
ChargeRecurring
interval
string
The interval at which the recurring charge is applied. Examples include "month", "year", etc.
Enum
interval_time
number
status
string
Current status of the charge.
Enum
capped_amount
number
The maximum amount that can be charged for a particular service or item
activated_on
string
| date-time
Nullable
Date and time when the charge was activated.
cancelled_on
string
| date-time
Nullable
Date and time when the charge was cancelled.
billing_date
string
| date-time
Nullable
The date when the billing occurred. This field is optional and may be null if the billing date is not specified.
current_period
object (SubscriptionTrialPeriod)
SubscriptionTrialPeriod
start_date
string
| date-time
The start date and time of the trial period.
end_date
string
| date-time
The end date and time of the trial period.
modified_at
string
| date-time
Date and time when the charge details were last modified.
created_at
string
| date-time
Date and time when the charge was created.
is_test
boolean
Indicates whether the operation or data is in a test mode.
company_id
string
The unique identifier of the company.
meta
object
Additional metadata associated with the charge.
__v
number
Internal version key for the charge record.
return_url
string
The URL passed in request which extension expects in return.
confirm_url
string
URL to which users are redirected to post initiation of extension installation.
Examples
Parameters
company_id:
20
extension_id:
"6051c97bf1c0f40d96d85ca4"
body:
body
Was this section helpful?
POST
Response