Skip to main content

Billing

Manages billing information of the platform subscriptions, including invoice generation.

Subscription

Subscription manages subscription and billing operations across various business lines and ordering channels such as GoFynd, Uniket, Ecommerce, and Marketplaces like Myntra, Amazon, Flipkart, etc. It enables thorough handling of both recurring and one-time charges, with capabilities to initiate, modify, and cancel subscriptions tailored to dynamic business needs. For instance, a seller on the Marketplace channel might subscribe to a specialized logistics service billed monthly, with the flexibility to adjust or terminate the subscription as their business evolves. It also supports coupon verification, seamlessly integrating promotional discounts during transactions or subscription renewals. Furthermore, seller can manage invoices and engage with diverse subscription plans customized for specific channels. It facilitates effortless plan upgrades or downgrades, allowing for instance, an E-commerce retailer to upgrade from a standard to an enterprise plan with enhanced features, or downgrade based on current needs. This comprehensive toolkit not only simplifies billing operations but also ensures subscription services are precisely aligned with the distinct demands of each sales channel, thus enhancing flexibility and bolstering customer engagement.

Operations
GET
/service/platform/billing/v1.0/company/{company_id}/coupon/check-validity
# Verify coupon validity
POST
/service/platform/billing/v1.0/company/{company_id}/extension/{extension_id}/subscription
# Register extension for the seller
GET
/service/platform/billing/v1.0/company/{company_id}/extension/{extension_id}/subscription/{subscription_id}
# Get subscription charge details
POST
/service/platform/billing/v1.0/company/{company_id}/extension/{extension_id}/subscription/{subscription_id}/cancel
# Cancel a subscription charge
POST
/service/platform/billing/v1.0/company/{company_id}/extension/{extension_id}/one_time_charge
# Generate a one-time charge
GET
/service/platform/billing/v1.0/company/{company_id}/extension/{extension_id}/charge/{charge_id}
# Obtain charge details
GET
/service/platform/billing/v1.0/company/{company_id}/invoice/list
# Get invoices
GET
/service/platform/billing/v1.0/company/{company_id}/invoice/{invoice_id}
# Get a specific invoice
GET
/service/platform/billing/v1.0/company/{company_id}/subscription/customer-detail
# Get seller details
POST
/service/platform/billing/v1.0/company/{company_id}/subscription/customer-detail
# Update or insert seller details
GET
/service/platform/billing/v1.0/company/{company_id}/subscription/current
# Get subscription details
GET
/service/platform/billing/v1.0/company/{company_id}/subscription/current-limit
# Obtain feature limit configurations
POST
/service/platform/billing/v1.0/company/{company_id}/subscription/activate
# Activate a subscription plan
POST
/service/platform/billing/v1.0/company/{company_id}/subscription/cancel
# Cancel a subscription plan
GET
/service/platform/billing/v1.0/company/{company_id}/plans
# Get enterprise-level plans
PATCH
/service/platform/billing/v1.0/company/{company_id}/plan/status
# Update subscription plan status
POST
/service/platform/billing/v1.0/company/{company_id}/payment/initiate
# Subscribe to a plan
GET
/service/platform/billing/v1.0/company/{company_id}/entity/detail
# Generic api to get the entity detail
GET

Verify coupon validity

Checks whether a coupon code is valid for discounts while billing.
Parameters
plan
string
ID of the plan.
couponCode
string
Coupon code.
Response
200
400
Success
CheckValidityResponse
is_valid
boolean
Optional
discount_amount
number
Optional
Examples
Parameters
plan:
"value"
couponCode:
"value"
Was this section helpful?
GET
/service/platform/billing/v1.0/company/{company_id}/coupon/check-validity
Loading...
Response
Loading...
POST

Register extension for the seller

Register a subscription charge for a seller using your extension.
Parameters
extensionId
string
Extension _id
body
object (CreateSubscriptionCharge)
CreateSubscriptionCharge
name
string
trial_days
integer
| int32
Optional
line_items
array of object (ChargeLineItem)
Array of ChargeLineItem
is_test
boolean
Optional
return_url
string
Response
200
400
Success
CreateSubscriptionResponse
subscription
object (EntitySubscription)
Optional
EntitySubscription
confirm_url
string
Optional
Examples
Parameters
extensionId:
"value"
body:
body
Was this section helpful?
POST
/service/platform/billing/v1.0/company/{company_id}/extension/{extension_id}/subscription
Loading...
Response
Loading...
GET

Get subscription charge details

Retrieve detailed information about subscription charges using this API.
Parameters
extensionId
string
Extension _id
subscriptionId
string
Subscription charge _id
Response
200
404
Success
EntitySubscription
_id
string
Optional
name
string
Optional
status
string
Optional
Enum
company_id
integer
| int32
Optional
activated_on
string
Optional
cancelled_on
string
Optional
trial_days
integer
| int32
Optional
trial_period
object (SubscriptionTrialPeriod)
Optional
SubscriptionTrialPeriod
metadata
object
Optional
line_items
array of object (SubscriptionCharge)
Optional
Array of SubscriptionCharge
Examples
Parameters
extensionId:
"value"
subscriptionId:
"value"
Was this section helpful?
GET
/service/platform/billing/v1.0/company/{company_id}/extension/{extension_id}/subscription/{subscription_id}
Loading...
Response
Loading...
POST

Cancel a subscription charge

When uninstalling, the extension statue will be marked as canceled.
Parameters
extensionId
string
Extension _id
subscriptionId
string
Subscription charge _id
Response
200
400
404
Success
EntitySubscription
_id
string
Optional
name
string
Optional
status
string
Optional
Enum
company_id
integer
| int32
Optional
activated_on
string
Optional
cancelled_on
string
Optional
trial_days
integer
| int32
Optional
trial_period
object (SubscriptionTrialPeriod)
Optional
SubscriptionTrialPeriod
metadata
object
Optional
line_items
array of object (SubscriptionCharge)
Optional
Array of SubscriptionCharge
Examples
Parameters
extensionId:
"value"
subscriptionId:
"value"
Was this section helpful?
POST
/service/platform/billing/v1.0/company/{company_id}/extension/{extension_id}/subscription/{subscription_id}/cancel
Loading...
Response
Loading...
POST

Generate a one-time charge

Generate a one-time charge for specific services or products.
Parameters
extensionId
string
Extension _id
body
object (CreateOneTimeCharge)
CreateOneTimeCharge
name
string
charge
object (OneTimeChargeItem)
OneTimeChargeItem
is_test
boolean
Optional
return_url
string
Response
200
400
Success
CreateOneTimeChargeResponse
charge
object (OneTimeChargeEntity)
Optional
OneTimeChargeEntity
confirm_url
string
Optional
Examples
Parameters
extensionId:
"value"
body:
body
Was this section helpful?
POST
/service/platform/billing/v1.0/company/{company_id}/extension/{extension_id}/one_time_charge
Loading...
Response
Loading...
GET

Obtain charge details

It will fetch the information regarding the subscription for the extension.
Parameters
extensionId
string
Extension _id
chargeId
string
Standalone charge _id
Response
200
404
Success
OneTimeChargeEntity
_id
string
Optional
name
string
Optional
status
string
Optional
Enum
activated_on
string
Optional
cancelled_on
string
Optional
metadata
object
Optional
return_url
string
Optional
is_test
boolean
Optional
pricing_type
string
Optional
subscriber_id
string
Optional
entity_type
string
Optional
entity_id
string
Optional
meta
object
Optional
price
object (EntityChargePrice)
Optional
EntityChargePrice
Examples
Parameters
extensionId:
"value"
chargeId:
"value"
Was this section helpful?
GET
/service/platform/billing/v1.0/company/{company_id}/extension/{extension_id}/charge/{charge_id}
Loading...
Response
Loading...
GET

Get invoices

Retrieve invoices for billing and payment tracking.
Parameters
No Parameters
Response
200
Success
Invoices
data
array of object (InvoicesData)
Optional
Array of InvoicesData
start
integer
| int32
Optional
end
integer
| int32
Optional
limit
integer
| int32
Optional
page
integer
| int32
Optional
total
integer
| int32
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/billing/v1.0/company/{company_id}/invoice/list
Loading...
Response
Example response not available.
GET

Get a specific invoice

Retrieve a particular invoice's details by providing its unique ID.
Parameters
invoiceId
string
Invoice id
Response
200
Success
Invoice
invoice
object (InvoiceDetails)
Optional
InvoiceDetails
invoice_items
array of object (InvoiceItems)
Optional
Array of InvoiceItems
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/billing/v1.0/company/{company_id}/invoice/{invoice_id}
Loading...
Response
Example response not available.
GET

Get seller details

Retrieve seller information.
Parameters
No Parameters
Response
200
404
Success
SubscriptionCustomer
phone
object (Phone)
Optional
Phone
billing_address
object (SubscriptionBillingAddress)
Optional
SubscriptionBillingAddress
_id
string
Optional
unique_id
string
Optional
type
string
Optional
name
string
Optional
email
string
Optional
created_at
string
Optional
modified_at
string
Optional
data
object
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/billing/v1.0/company/{company_id}/subscription/customer-detail
Loading...
Response
Example response not available.
POST

Update or insert seller details

Allows you to modify or insert seller information in the billing system.
Parameters
body
object (SubscriptionCustomerCreate)
Customer upsert req data
SubscriptionCustomerCreate
phone
object (Phone)
Optional
Phone
billing_address
object (SubscriptionBillingAddress)
Optional
SubscriptionBillingAddress
unique_id
string
Optional
type
string
Optional
name
string
Optional
email
string
Optional
Response
200
404
500
Success
SubscriptionCustomer
phone
object (Phone)
Optional
Phone
billing_address
object (SubscriptionBillingAddress)
Optional
SubscriptionBillingAddress
_id
string
Optional
unique_id
string
Optional
type
string
Optional
name
string
Optional
email
string
Optional
created_at
string
Optional
modified_at
string
Optional
data
object
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/billing/v1.0/company/{company_id}/subscription/customer-detail
Loading...
Response
Example response not available.
GET

Get subscription details

t will show the most recent subscriptions of the seller for each ordering channel, regardless of their status—whether they're active, cancelled, or otherwise.
Parameters
No Parameters
Response
200
500
Success
SubscriptionStatus
is_enabled
boolean
Optional
subscription
object (Subscription)
Optional
Subscription
latest_invoice
object (InvoicesData)
Optional
InvoicesData
next_plan
object (Plan)
Optional
Plan
current_subscriptions
array of object (Subscription)
Optional
Array of Subscription
mandate_amount
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/billing/v1.0/company/{company_id}/subscription/current
Loading...
Response
Example response not available.
GET

Obtain feature limit configurations

Retrieve configuration settings for feature limits in subscription plans.
Parameters
productSuite
string
Optional
type
string
Optional
Response
200
500
Success
SubscriptionLimit
application
object (SubscriptionLimitApplication)
Optional
SubscriptionLimitApplication
marketplace
object (SubscriptionLimitMarketplace)
Optional
SubscriptionLimitMarketplace
other_platform
object (SubscriptionLimitOtherPlatform)
Optional
SubscriptionLimitOtherPlatform
team
object (SubscriptionLimitTeam)
Optional
SubscriptionLimitTeam
products
object (SubscriptionLimitProducts)
Optional
SubscriptionLimitProducts
extensions
object (SubscriptionLimitExtensions)
Optional
SubscriptionLimitExtensions
integrations
object (SubscriptionLimitIntegrations)
Optional
SubscriptionLimitIntegrations
is_trial_plan
boolean
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/billing/v1.0/company/{company_id}/subscription/current-limit
Loading...
Response
Example response not available.
POST

Activate a subscription plan

Activate a specific subscription plan for a customer.
Parameters
body
object (SubscriptionActivateReq)
Subscription activate req
SubscriptionActivateReq
unique_id
string
Optional
type
string
Optional
product_suite
string
Optional
plan_id
string
Optional
payment_method
string
Optional
Response
200
404
500
Success
SubscriptionActivateRes
success
boolean
Optional
data
object (Subscription)
Optional
Subscription
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/billing/v1.0/company/{company_id}/subscription/activate
Loading...
Response
Example response not available.
POST

Cancel a subscription plan

The seller will initiate a request to cancel their current subscription on the platform.
Parameters
body
object (CancelSubscriptionReq)
subscription cancellation req
CancelSubscriptionReq
unique_id
string
Optional
type
string
Optional
product_suite
string
Optional
subscription_id
string
Optional
Response
200
404
500
Success
CancelSubscriptionRes
success
boolean
Optional
data
object (Subscription)
Optional
Subscription
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/billing/v1.0/company/{company_id}/subscription/cancel
Loading...
Response
Example response not available.
GET

Get enterprise-level plans

Retrieve available enterprise-level subscription plans.
Parameters
No Parameters
Response
200
500
Success
Array of Plan
recurring
object (PlanRecurring)
Optional
PlanRecurring
is_trial_plan
boolean
Optional
plan_group
string
Optional
tag_lines
array of string
Optional
currency
string
Optional
is_active
boolean
Optional
is_visible
boolean
Optional
trial_period
number
Optional
addons
array of string
Optional
tags
array of string
Optional
type
string
Optional
country
string
Optional
_id
string
Optional
name
string
Optional
description
string
Optional
amount
number
Optional
product_suite_id
string
Optional
created_at
string
Optional
modified_at
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/billing/v1.0/company/{company_id}/plans
Loading...
Response
Example response not available.
PATCH

Update subscription plan status

Modify the status of a subscription plan.
Parameters
body
object (PlanStatusUpdateReq)
plan status req
PlanStatusUpdateReq
plan_id
string
Optional
reason
string
Optional
seller_status
string
Optional
Response
200
400
500
Success
Plan
recurring
object (PlanRecurring)
Optional
PlanRecurring
is_trial_plan
boolean
Optional
plan_group
string
Optional
tag_lines
array of string
Optional
currency
string
Optional
is_active
boolean
Optional
is_visible
boolean
Optional
trial_period
number
Optional
addons
array of string
Optional
tags
array of string
Optional
type
string
Optional
country
string
Optional
_id
string
Optional
name
string
Optional
description
string
Optional
amount
number
Optional
product_suite_id
string
Optional
created_at
string
Optional
modified_at
string
Optional
Examples
Parameters
body:
body
Was this section helpful?
PATCH
/service/platform/billing/v1.0/company/{company_id}/plan/status
Loading...
Response
Example response not available.
POST

Subscribe to a plan

Subscribe to a specific billing plan.
Parameters
body
object (SunscribePlan)
subscribe plan.
SunscribePlan
entity_type
string
Optional
collection_type
string
Optional
plan_id
string
Optional
callback_url
string
Optional
meta
object (Meta)
Optional
Meta
Response
200
404
500
Success
SubscribePlanRes
redirect_url
string
Optional
transaction_id
string
Optional
current_status
string
Optional
meta
object (Meta)
Optional
Meta
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/billing/v1.0/company/{company_id}/payment/initiate
Loading...
Response
Example response not available.
GET

Generic api to get the entity detail

Generic api to get the entity detail
Parameters
entityName
string
Entity name.
entityId
string
Optional
Entity unique id.
channel
string
Ordering channel.
component
string
Optional
The coponents the user would like to know.
componentName
string
Optional
The name of component the preferred to be fetched.
Response
200
400
404
500
Success
EntityResponse
success
boolean
Optional
page
integer
| int32
Optional
page_size
integer
| int32
Optional
items
array of object (Details)
Optional
Array of Details
Examples
Parameters
entityName:
"value"
entityId:
"value"
channel:
"value"
component:
"value"
componentName:
"value"
Was this section helpful?
GET
/service/platform/billing/v1.0/company/{company_id}/entity/detail
Loading...
Response
Loading...