HighLevel: Payments schemas

← Payments operations · All schemas

Create Coupon — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location Id
altType	string	Required within parent	Alt Type One of: location
applyToFuturePayments	boolean	Optional	Is Coupon applicable on upcoming subscription transactions Default: true
applyToFuturePaymentsConfig	JSON	Optional	If coupon is applicable on upcoming subscription transactions, how many months should it be applicable for a subscription Default: {"type": "forever"}
applyToFuturePaymentsConfig (allOf 1)	Model	All variants apply	Expand Create Coupon — request body — body / applyToFuturePaymentsConfig / durationType: months, type: forever, fixed
code	string	Required within parent	Coupon Code
discountType	string	Required within parent	Discount Type One of: percentage, amount
discountValue	number	Required within parent	Discount Value
endDate	string	Optional	End date in YYYY-MM-DDTHH:mm:ssZ format
limitPerCustomer	boolean	Optional	Limits whether a coupon can be redeemed only once per customer. Default: false
name	string	Required within parent	Coupon Name
priceIds	array	Optional	Price Ids
priceIds[]	string	Each item
productIds	array	Optional	Product Ids
productIds[]	string	Each item
startDate	string	Required within parent	Start date in YYYY-MM-DDTHH:mm:ssZ format
usageLimit	number	Optional	Max number of times coupon can be used
variantIds	array	Optional	Variant Ids
variantIds[]	string	Each item

Referenced models: Create Coupon — request body — body / applyToFuturePaymentsConfig / durationType: months, type: forever, fixed

Create Coupon — request body — body / applyToFuturePaymentsConfig / durationType: months, type: forever, fixed

Field	Type	Presence	Description and constraints
$	object	Root
duration	number	Required within parent	Duration the coupon to be applied in a subscription
durationType	string	Required within parent	Type of the duration One of: months
type	string	Required within parent	Type of the config One of: forever, fixed

Create White-label Integration Provider — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	location Id / company Id based on altType
altType	string	Required within parent	Alt Type One of: location
description	string	Required within parent	A brief description providing additional information about the integration provider.
imageUrl	string	Required within parent	The URL to an image representing the integration provider. The imageUrl should start with "https://" and ensure that this URL is publicly accessible.
provider	string	Required within parent	The type of payment provider associated with the integration provider. One of: authorize-net, nmi
title	string	Required within parent	The title or name of the integration provider.
uniqueName	string	Required within parent	A unique name given to the integration provider, uniqueName must start and end with a character. Only lowercase characters and hyphens (-) are supported

Create White-label Integration Provider — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier of the integration provider.
altId	string	Required within parent	The altId / locationId of the integration provider.
altType	string	Required within parent	The altType of the integration provider.
createdAt	string	Required within parent	The timestamp when the integration provider was created. Format: date-time
description	string	Required within parent	A brief description providing additional information about the integration provider.
imageUrl	string	Required within parent	The URL to an image representing the integration provider.
provider	string	Required within parent	The payment provider associated with the integration provider.
route	string	Required within parent	The route name associated with the integration provider.
title	string	Required within parent	The title or name of the integration provider.
updatedAt	string	Required within parent	The timestamp when the integration provider was last updated. Format: date-time

Create new integration — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Required within parent	Description of payment gateway. Shown on the payments integrations page as subtext
imageUrl	string	Required within parent	Public image url for logo of the payment gateway displayed on the payments integrations page.
name	string	Required within parent	The name of the custom provider
paymentsUrl	string	Required within parent	This url will be loaded in iFrame to start a payment session.
queryUrl	string	Required within parent	The url used for querying payments related events. Ex. verify, refund, subscription etc.
supportsSubscriptionSchedule	boolean	Required within parent	Whether the config supports subscription schedule or not. true represents config supports subscription schedule

Create new integration — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the custom provider.
createdAt	string	Required within parent	The creation timestamp of the custom provider. Format: date-time
deleted	boolean	Required within parent	Whether the config is deleted or not. true represents config is deleted
description	string	Required within parent	Description of payment gateway. Shown on the payments integrations page as subtext
imageUrl	string	Required within parent	Public image url for logo of the payment gateway displayed on the payments integrations page.
locationId	string	Required within parent	Location id
marketplaceAppId	string	Required within parent	The application id of marketplace
name	string	Required within parent	The name of the custom provider
paymentProvider	object	Optional	Payment provider details.
paymentsUrl	string	Required within parent	This url will be loaded in iFrame to start a payment session.
queryUrl	string	Required within parent	The url used for querying payments related events. Ex. verify, refund, subscription etc.
traceId	string	Optional	Trace id of the custom provider.
updatedAt	string	Required within parent	The last update timestamp of the custom provider. Format: date-time

Create order fulfillment — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	One of: location
items	array	Required within parent	Fulfilled items
items[]	Model	Each item	Expand Create order fulfillment — request body — body items item
notifyCustomer	boolean	Required within parent	Need to send a notification to customer
trackings	array	Required within parent	Fulfillment tracking information
trackings[]	Model	Each item	Expand Create order fulfillment — request body — body trackings item

Referenced models: Create order fulfillment — request body — body items item, Create order fulfillment — request body — body trackings item

Create order fulfillment — request body — body items item

Field	Type	Presence	Description and constraints
$	object	Root
priceId	string	Required within parent	The id of product price
qty	number	Required within parent	The no of quantity of the item

Create order fulfillment — request body — body trackings item

Field	Type	Presence	Description and constraints
$	object	Root
shippingCarrier	string	Optional	Shipping carrier name
trackingNumber	string	Optional	Tracking number provided by the shipping carrier
trackingUrl	string	Optional	Tracking URL

Create order fulfillment — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	JSON	Required within parent	fulfillment data
data (allOf 1)	Model	All variants apply	Expand List fulfillment — response body — data item
status	boolean	Required within parent	Status of api action

Referenced models: List fulfillment — response body — data item

Custom-provider marketplace app update capabilities — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
companyId	string	Optional	Company id. Mandatory if locationId is not provided
locationId	string	Optional	Location / Sub-account id. Mandatory if companyId is not provided
supportsSubscriptionSchedules	boolean	Required within parent	Whether the marketplace app supports subscription schedules or not

Custom-provider marketplace app update capabilities — response body

Field	Type	Presence	Description and constraints
$	object	Root
success	boolean	Required within parent	Whether the custom provider capabilities are updated or not. true represents capabilities are updated

Delete Coupon — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location Id
altType	string	Required within parent	Alt Type One of: location
id	string	Required within parent	Coupon Id

Delete Coupon — response body

Field	Type	Presence	Description and constraints
$	object	Root
success	boolean	Required within parent	Indicates whether the delete was successful
traceId	string	Required within parent	Unique identifier for tracing this API request

Deleting an existing integration — response body

Field	Type	Presence	Description and constraints
$	object	Root
success	boolean	Required within parent	Whether the custom provider config is disconnect or not. true represents config is disconnect

Disconnect existing provider config — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
liveMode	boolean	Required within parent	Whether the config is for test mode or live mode. true represents config is for live payments

Fetch Coupon — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Unique MongoDB identifier for the coupon
altId	string	Required within parent	Location Id
altType	string	Required within parent	Type of entity
applyToFuturePayments	boolean	Required within parent	Indicates if the coupon applies to future recurring payments
applyToFuturePaymentsConfig	JSON	Required within parent	Configuration for how the coupon applies to future payments
applyToFuturePaymentsConfig (allOf 1)	Model	All variants apply	Expand Fetch Coupon — response body — applyToFuturePaymentsConfig / type: forever, fixed
code	string	Required within parent	Redemption code for the coupon
createdAt	string	Required within parent	Creation timestamp
discountType	string	Required within parent	Type of discount (percentage or amount) Known values: percentage, amount
discountValue	JSON	Required within parent
discountValue (anyOf 1)	number	Alternative	Value of the discount (percentage or fixed amount)
discountValue (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
endDate	string	Optional	End date when the coupon expires
limitPerCustomer	JSON	Required within parent
limitPerCustomer (anyOf 1)	number	Alternative	Maximum number of times a customer can use this coupon (0 for unlimited)
limitPerCustomer (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Required within parent	Display name of the coupon
startDate	string	Required within parent	Date when the coupon becomes active
status	string	Required within parent	Current status of the coupon Known values: scheduled, active, expired
traceId	string	Required within parent	Unique identifier for tracing this API request
updatedAt	string	Required within parent	Last update timestamp
usageCount	JSON	Required within parent
usageCount (anyOf 1)	number	Alternative	Number of times the coupon has been used
usageCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
userId	string	Optional	User ID associated with the coupon (if applicable)

Referenced models: Fetch Coupon — response body — applyToFuturePaymentsConfig / type: forever, fixed

Fetch Coupon — response body — applyToFuturePaymentsConfig / type: forever, fixed

Field	Type	Presence	Description and constraints
$	object	Root
duration	JSON	Optional
duration (anyOf 1)	number	Alternative	Duration value for fixed type configurations
duration (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
durationType	string	Optional	Duration type for fixed configurations (e.g. months)
type	string	Required within parent	Type of future payments configuration Known values: forever, fixed

Get Order by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the order.
altId	string	Required within parent	AltId is the unique identifier eg: location id.
altType	string	Required within parent	AltType is the type of identifier.
amount	JSON	Optional
amount (anyOf 1)	number	Alternative	Order value.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amountSummary	JSON	Optional	Amount details of the order.
amountSummary (allOf 1)	Model	All variants apply	Expand Get Order by ID — response body — amount Summary discount, subtotal
automaticTaxesCalculated	boolean	Optional	Automatic taxes applied for the Order
contactId	string	Optional	Contact id corresponding to the order.
contactSnapshot	object	Optional	Contact details of the order.
coupon	object	Optional	Coupon details of the order.
createdAt	string	Required within parent	The creation timestamp of the order. Format: date-time
createdBy	string	Optional	User ID who created the order.
currency	string	Optional	Currency in which order was created.
fingerprint	string	Optional	Fingerprint id of the order.
fulfillmentStatus	string	Optional	Fulfillment status of the order.
items	array	Optional	Item details of the order.
items[]	string	Each item
liveMode	boolean	Optional	Order is in live / test mode.
markAsTest	boolean	Optional	Is test order.
meta	object	Optional	Meta details of the order.
source	JSON	Optional	Source details of the order.
source (allOf 1)	Model	All variants apply	Expand Get Order by ID — response body — source id, meta, name, sub Type, type
status	string	Required within parent	The status of the order (e.g., completed).
taxCalculationProvider	object	Optional	Provider name for automatic tax calculation
traceId	string	Optional	Trace id of the order.
trackingId	string	Optional	Tracking id of the order.
updatedAt	string	Required within parent	The last update timestamp of the order. Format: date-time

Referenced models: Get Order by ID — response body — amount Summary discount, subtotal, Get Order by ID — response body — source id, meta, name, sub Type, type

Get Order by ID — response body — amount Summary discount, subtotal

Field	Type	Presence	Description and constraints
$	object	Root
discount	JSON	Optional
discount (anyOf 1)	number	Alternative	Discount value on order.
discount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
subtotal	JSON	Required within parent
subtotal (anyOf 1)	number	Alternative	Order sub-total value.
subtotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Order by ID — response body — source id, meta, name, sub Type, type

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent
meta	object	Optional
name	string	Optional
subType	string	Optional	Known values: one_step_order_form, two_step_order_form, upsell, tap_to_pay, card_payment, store, contact_view, email_campaign, payments_dashboard, shopify, subscription_view, store_upsell, woocommerce, service, meeting, imported_csv, qr_code, saas_one_time, saas_subscription
type	string	Required within parent	Known values: funnel, website, invoice, calendar, text2Pay, document_contracts, membership, mobile_app, communities, point_of_sale, manual, form, survey, payment_link, external

Get Subscription by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the subscription.
altId	string	Required within parent	AltId is the unique identifier eg: location id.
altType	object	Required within parent	AltType is the type of identifier.
amount	JSON	Optional
amount (anyOf 1)	number	Alternative	Subscription value.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
autoPayment	object	Optional	Auto payment details of the subscription.
canceledAt	string	Optional	Cancellation timestamp of the subscription. Format: date-time
canceledBy	string	Optional	User id who cancelled the subscription.
contactId	string	Optional	Contact id corresponding to the subscription.
contactSnapshot	object	Optional	Contact details of the subscriber.
coupon	object	Optional	Coupon details of the subscription.
createdAt	string	Required within parent	The creation timestamp of the subscription. Format: date-time
createdBy	string	Optional	User ID who created the subscription.
currency	string	Optional	Currency in which subscription was made.
entityId	string	Optional	Entity id for the subscription. e.g: order id
entitySource	JSON	Optional	Entity source details for the subscription.
entitySource (allOf 1)	Model	All variants apply	Expand Get Order by ID — response body — source id, meta, name, sub Type, type
entityType	string	Optional	Entity type of subscription (eg: order).
ipAddress	string	Optional	Ip address from where subscription was initiated.
liveMode	boolean	Optional	Subscription is in live / test mode.
markAsTest	boolean	Optional	Is test subscription.
meta	object	Optional	Meta details of the subscription.
paymentProvider	object	Optional	Payment provider details for the subscription.
recurringProduct	object	Optional	Recurring product details of the subscription.
schedule	JSON	Optional	Scedule details for the subscription.
schedule (allOf 1)	Model	All variants apply	Expand Get Subscription by ID — response body — schedule execute At, rrule
status	object	Optional	Subscription status.
subscriptionId	string	Optional	Subscription id for subscription.
subscriptionSnapshot	object	Optional	Snapshot of subscription.
traceId	string	Optional	Trace id of the subscription.
updatedAt	string	Required within parent	The last update timestamp of the subscription. Format: date-time

Referenced models: Get Order by ID — response body — source id, meta, name, sub Type, type, Get Subscription by ID — response body — schedule execute At, rrule

Get Subscription by ID — response body — schedule execute At, rrule

Field	Type	Presence	Description and constraints
$	object	Root
executeAt	string	Optional
rrule	Model	Optional	Expand Get Subscription by ID — response body — schedule execute At, rrule rrule

Referenced models: Get Subscription by ID — response body — schedule execute At, rrule rrule

Get Subscription by ID — response body — schedule execute At, rrule rrule

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Optional
count (anyOf 1)	number	Alternative	Max number of task executions
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
dayOfMonth	JSON	Optional
dayOfMonth (anyOf 1)	number	Alternative	-1, 1, 2, 3, ..., 27, 28
dayOfMonth (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
dayOfWeek	string	Optional	Known values: mo, tu, we, th, fr, sa, su
daysBefore	JSON	Optional
daysBefore (anyOf 1)	number	Alternative	Execute task number of days before
daysBefore (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
endDate	string	Optional	End date in YYYY-MM-DD format
endTime	string	Optional	End time in HH:mm:ss format
interval	JSON	Required within parent
interval (anyOf 1)	number	Alternative
interval (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
intervalType	string	Required within parent	Known values: yearly, monthly, weekly, daily, hourly, minutely, secondly
monthOfYear	string	Optional	Known values: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec
numOfWeek	JSON	Optional
numOfWeek (anyOf 1)	number	Alternative	-1, 1, 2, 3, 4
numOfWeek (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startDate	string	Required within parent	Start date in YYYY-MM-DD format
startTime	string	Optional	Start time in HH:mm:ss format

Get Transaction by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the transaction.
altId	string	Required within parent	AltId is the unique identifier eg: location id.
altType	string	Required within parent	AltType is the type of identifier.
amount	JSON	Optional
amount (anyOf 1)	number	Alternative	Transaction value.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amountRefunded	JSON	Optional
amountRefunded (anyOf 1)	number	Alternative	Transaction amount refunded.
amountRefunded (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
chargeId	string	Optional	Charge id for transaction.
chargeSnapshot	object	Optional	Charge snapshot of transaction.
contactId	string	Optional	Contact id corresponding to the transaction.
contactSnapshot	object	Optional	Contact details of the transaction.
createdAt	string	Required within parent	The creation timestamp of the transaction. Format: date-time
createdBy	string	Optional	User ID who created the transaction.
currency	string	Optional	Currency in which transaction was made.
entityId	string	Optional	Entity id for the transaction. e.g: order id
entitySource	JSON	Optional	Entity source details for the transaction.
entitySource (allOf 1)	Model	All variants apply	Expand Get Order by ID — response body — source id, meta, name, sub Type, type
entityType	string	Optional	Entity type of transaction (eg: order).
invoiceId	string	Optional	Invoice id for the transaction.
ipAddress	string	Optional	Ip address from where transaction was initiated.
isParent	boolean	Optional	Is parent transaction.
liveMode	boolean	Optional	Transaction is in live / test mode.
markAsTest	boolean	Optional	Is test transaction.
mergedFromContactId	string	Optional	ID of the contact that was merged from.
meta	object	Optional	Meta details of the transaction.
paymentProvider	object	Optional	Payment provider details of the transaction.
qboResponse	object	Optional	Qbo details of the transaction.
qboSynced	boolean	Optional	Is transaction qbo synced.
receiptId	string	Optional	Receipt id for transaction.
status	object	Optional	Transaction status.
subscriptionId	string	Optional	Subscription id for transaction.
traceId	string	Optional	Trace id of the transaction.
updatedAt	string	Required within parent	The last update timestamp of the transaction. Format: date-time

Referenced models: Get Order by ID — response body — source id, meta, name, sub Type, type

List Coupons — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	array	Required within parent	Array of coupon objects
data[]	Model	Each item	Expand List Coupons — response body — data item
totalCount	JSON	Required within parent
totalCount (anyOf 1)	number	Alternative	Total number of coupons matching the query criteria
totalCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
traceId	string	Required within parent	Unique identifier for tracing this API request

Referenced models: List Coupons — response body — data item

List Coupons — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Unique MongoDB identifier for the coupon
altId	string	Required within parent	Location Id
altType	string	Required within parent	Type of entity
applyToFuturePayments	boolean	Required within parent	Indicates if the coupon applies to future recurring payments
applyToFuturePaymentsConfig	JSON	Required within parent	Configuration for how the coupon applies to future payments
applyToFuturePaymentsConfig (allOf 1)	Model	All variants apply	Expand Fetch Coupon — response body — applyToFuturePaymentsConfig / type: forever, fixed
code	string	Required within parent	Redemption code for the coupon
createdAt	string	Required within parent	Creation timestamp
discountType	string	Required within parent	Type of discount (percentage or amount) Known values: percentage, amount
discountValue	JSON	Required within parent
discountValue (anyOf 1)	number	Alternative	Value of the discount (percentage or fixed amount)
discountValue (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
endDate	string	Optional	End date when the coupon expires
limitPerCustomer	JSON	Required within parent
limitPerCustomer (anyOf 1)	number	Alternative	Maximum number of times a customer can use this coupon (0 for unlimited)
limitPerCustomer (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Required within parent	Display name of the coupon
priceIds	array	Optional	Price Ids
priceIds[]	string	Each item
productIds	array	Optional	Product Ids
productIds[]	string	Each item
startDate	string	Required within parent	Date when the coupon becomes active
status	string	Required within parent	Current status of the coupon Known values: scheduled, active, expired
updatedAt	string	Required within parent	Last update timestamp
usageCount	JSON	Required within parent
usageCount (anyOf 1)	number	Alternative	Number of times the coupon has been used
usageCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
userId	string	Optional	User ID associated with the coupon (if applicable)
variantIds	array	Optional	Variant Ids
variantIds[]	string	Each item

Referenced models: Fetch Coupon — response body — applyToFuturePaymentsConfig / type: forever, fixed

List Orders — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	array	Required within parent	An array of orders
data[]	Model	Each item	Expand List Orders — response body — data item
totalCount	JSON	Required within parent
totalCount (anyOf 1)	number	Alternative	total orders count
totalCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Orders — response body — data item

List Orders — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the order.
altId	string	Required within parent	AltId is the unique identifier eg: location id.
altType	string	Required within parent	AltType is the type of identifier.
amount	JSON	Optional
amount (anyOf 1)	number	Alternative	Order value.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
contactEmail	string	Optional	Contact email corresponding to the order.
contactId	string	Optional	Contact id corresponding to the order.
contactName	string	Optional	Contact name corresponding to the order.
couponCode	string	Optional	Coupon code for the order.
createdAt	string	Required within parent	The creation timestamp of the order. Format: date-time
createdBy	string	Optional	User ID who created the order.
currency	string	Optional	Currency in which order was created.
discount	JSON	Optional
discount (anyOf 1)	number	Alternative	Discount value on order.
discount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fulfillmentStatus	string	Optional	Fulfillment status of the order.
liveMode	boolean	Optional	Order is in live / test mode.
onetimeProducts	JSON	Optional
onetimeProducts (anyOf 1)	number	Alternative	Total one time products in an order.
onetimeProducts (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
recurringProducts	JSON	Optional
recurringProducts (anyOf 1)	number	Alternative	Total recurring time products in an order.
recurringProducts (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sourceId	string	Optional	Source id for the order.
sourceMeta	object	Optional	Meta content for the source of order.
sourceName	string	Optional	Source name for the order.
sourceSubType	string	Optional	Source sub-type for the order.
sourceType	string	Required within parent	Source type of order (eg: funnel).
status	string	Required within parent	The status of the order (e.g., completed).
subtotal	JSON	Optional
subtotal (anyOf 1)	number	Alternative	Order sub-total value.
subtotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalProducts	JSON	Optional
totalProducts (anyOf 1)	number	Alternative	Total products in an order.
totalProducts (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Required within parent	The last update timestamp of the order. Format: date-time

List Subscriptions — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	array	Required within parent	An array of subscriptions
data[]	Model	Each item	Expand List Subscriptions — response body — data item
totalCount	JSON	Required within parent
totalCount (anyOf 1)	number	Alternative	total subscriptions count
totalCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Subscriptions — response body — data item

List Subscriptions — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the subscription.
altId	string	Required within parent	AltId is the unique identifier eg: location id.
altType	string	Required within parent	AltType is the type of identifier. Known values: location
amount	JSON	Optional
amount (anyOf 1)	number	Alternative	Subscription value.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
contactEmail	string	Optional	Contact email corresponding to the subscription.
contactId	string	Optional	Contact id corresponding to the subscription.
contactName	string	Optional	Contact name corresponding to the subscription.
createdAt	string	Required within parent	The creation timestamp of the subscription. Format: date-time
createdBy	string	Optional	User ID who created the subscription.
currency	string	Optional	Currency in which subscription occurred.
entityId	string	Optional	Entity id for the subscription. e.g: order id
entitySourceId	string	Optional	Entity source id for the subscription.
entitySourceMeta	object	Optional	Meta content for the entity source of subscription.
entitySourceName	string	Optional	Entity source name for the subscription.
entitySourceType	string	Required within parent	Entity source type of subscription (eg: funnel).
entityType	string	Optional	Entity type of subscription (eg: order).
ipAddress	string	Optional	Ip address from where subscription was initiated.
liveMode	boolean	Optional	Subscription is in live / test mode.
paymentProviderConnectedAccount	string	Optional	Payment provider connected account id for subscription.
paymentProviderType	string	Optional	Payment provider for subscription.
status	object	Required within parent	The status of the subscription (e.g., succeeded).
subscriptionId	string	Optional	Subscription id for subscription.
subscriptionSnapshot	object	Optional	Snapshot of subscription.
updatedAt	string	Required within parent	The update timestamp of the subscription. Format: date-time

List Transactions — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	array	Required within parent	An array of transactions
data[]	Model	Each item	Expand List Transactions — response body — data item
totalCount	JSON	Required within parent
totalCount (anyOf 1)	number	Alternative	total transactions count
totalCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Transactions — response body — data item

List Transactions — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the transaction.
altId	string	Required within parent	AltId is the unique identifier eg: location id.
altType	string	Required within parent	AltType is the type of identifier.
amount	JSON	Optional
amount (anyOf 1)	number	Alternative	Transaction value.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amountRefunded	JSON	Optional
amountRefunded (anyOf 1)	number	Alternative	Transaction amount refunded.
amountRefunded (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
chargeId	string	Optional	Charge id for transaction.
chargeSnapshot	object	Optional	Charge snapshot of transaction.
contactEmail	string	Optional	Contact email corresponding to the transaction.
contactId	string	Optional	Contact id corresponding to the transaction.
contactName	string	Optional	Contact name corresponding to the transaction.
createdAt	string	Required within parent	The creation timestamp of the transaction. Format: date-time
createdBy	string	Optional	User ID who created the transaction.
currency	string	Optional	Currency in which transaction occurred.
entityId	string	Optional	Entity id for the transaction. e.g: order id
entitySourceId	string	Optional	Entity source id for the transaction.
entitySourceMeta	object	Optional	Meta content for the entity source of transaction.
entitySourceName	string	Optional	Entity source name for the transaction.
entitySourceSubType	string	Optional	Entity source sub-type of the transactions.
entitySourceType	string	Required within parent	Entity source type of transaction (eg: funnel).
entityType	string	Optional	Entity type of transaction (eg: order).
fulfilledAt	string	Required within parent	The charged timestamp of the transaction. Format: date-time
ipAddress	string	Optional	Ip address from where transaction was initiated.
liveMode	boolean	Optional	Transaction is in live / test mode.
mergedFromContactId	string	Optional	ID of the contact that was merged from.
paymentMethod	object	Optional	Transaction payment method details.
paymentProviderConnectedAccount	string	Optional	Payment provider account id for transaction.
paymentProviderType	string	Optional	Payment provider for transaction.
status	object	Required within parent	The status of the transaction (e.g., succeeded).
subscriptionId	string	Optional	Subscription id for transaction.
updatedAt	string	Required within parent	The update timestamp of the transaction. Format: date-time

List White-label Integration Providers — response body

Field	Type	Presence	Description and constraints
$	object	Root
providers	JSON	Required within parent	list of integration provider.
providers (allOf 1)	Model	All variants apply	Expand Create White-label Integration Provider — response body

Referenced models: Create White-label Integration Provider — response body

List fulfillment — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	array	Required within parent	An array of fulfilled items
data[]	Model	Each item	Expand List fulfillment — response body — data item
status	boolean	Required within parent	Status of api action

Referenced models: List fulfillment — response body — data item

List fulfillment — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the fulfillment item.
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	Known values: location
createdAt	string	Required within parent	created at
items	array	Required within parent	Fulfilled items
items[]	Model	Each item	Expand List fulfillment — response body — data item items item
trackings	array	Required within parent	Fulfillment tracking information
trackings[]	Model	Each item	Expand Create order fulfillment — request body — body trackings item
updatedAt	string	Required within parent	updated at

Referenced models: Create order fulfillment — request body — body trackings item, List fulfillment — response body — data item items item

List fulfillment — response body — data item items item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The id of product price
name	string	Required within parent	Name
price	JSON	Required within parent	Price details
price (allOf 1)	Model	All variants apply	Expand Create Price for a Product — response body
product	JSON	Required within parent	Product details
product (allOf 1)	Model	All variants apply	Expand Create Product — response body
qty	JSON	Required within parent
qty (anyOf 1)	number	Alternative	The no of quantity of the current fulfilled item
qty (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Create Product — response body, Create Price for a Product — response body

Record Order Payment — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	location Id / company Id based on altType
altType	string	Required within parent	Alt Type One of: location
amount	number	Optional	Amount to be paid against the invoice.
card	JSON	Optional	Details of Card if used for payment
card (allOf 1)	Model	All variants apply	Expand Record Order Payment — request body — body / card / type: visa, mastercard, other
cheque	JSON	Optional	Details of the Cheque if used for payment
cheque (allOf 1)	Model	All variants apply	Expand Record a manual payment for an invoice — request body — body cheque
isPartialPayment	boolean	Optional	Indicates if the order is intended to be a partial payment.
meta	object	Optional	Meta data to be recorded with the transaction
mode	string	Required within parent	manual payment method One of: cash, card, cheque, bank_transfer, other
notes	string	Optional	Any note to be recorded with the transaction

Referenced models: Record a manual payment for an invoice — request body — body cheque, Record Order Payment — request body — body / card / type: visa, mastercard, other

Record Order Payment — request body — body / card / type: visa, mastercard, other

Field	Type	Presence	Description and constraints
$	object	Root
last4	string	Required within parent	Last 4 digit of the card
type	string	Required within parent	One of: visa, mastercard, other

Record Order Payment — response body

Field	Type	Presence	Description and constraints
$	object	Root
success	boolean	Required within parent	Success status of the request

Update Coupon — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location Id
altType	string	Required within parent	Alt Type One of: location
applyToFuturePayments	boolean	Optional	Is Coupon applicable on upcoming subscription transactions Default: true
applyToFuturePaymentsConfig	JSON	Optional	If coupon is applicable on upcoming subscription transactions, how many months should it be applicable for a subscription Default: {"type": "forever"}
applyToFuturePaymentsConfig (allOf 1)	Model	All variants apply	Expand Create Coupon — request body — body / applyToFuturePaymentsConfig / durationType: months, type: forever, fixed
code	string	Required within parent	Coupon Code
discountType	string	Required within parent	Discount Type One of: percentage, amount
discountValue	number	Required within parent	Discount Value
endDate	string	Optional	End date in YYYY-MM-DDTHH:mm:ssZ format
id	string	Required within parent	Coupon Id
limitPerCustomer	boolean	Optional	Limits whether a coupon can be redeemed only once per customer. Default: false
name	string	Required within parent	Coupon Name
priceIds	array	Optional	Price Ids
priceIds[]	string	Each item
productIds	array	Optional	Product Ids
productIds[]	string	Each item
startDate	string	Required within parent	Start date in YYYY-MM-DDTHH:mm:ssZ format
usageLimit	number	Optional	Max number of times coupon can be used
variantIds	array	Optional	Variant Ids
variantIds[]	string	Each item

Referenced models: Create Coupon — request body — body / applyToFuturePaymentsConfig / durationType: months, type: forever, fixed