Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
APPS

Get merchant app billing information

Retrieves the status of a merchant's app billing, including the current subscription tier and trial status. Requires an OAuth-generated token.

get/v3/apps/{appId}/merchants/{mId}/billing_info

Path parameters

appIdstring required

App Id

mIdstring required

Merchant Id

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Response

idstring

App UUID

isInTrialboolean

Returns true if a trial period is enabled for a paid app. You can choose the number of trial period days for your app.

billableboolean

Returns true if a merchant using an app is billable, and false if there is an app suppression on this particular app for the specific merchant.

appBillableboolean

Returns false if all apps are non-billable for the specific merchant.

planBillableboolean

Returns false if plan fees are non-billable for the specific merchant.

appExportableboolean

Returns false if app charges are not exportable for the specific merchant.

planExportableboolean

Returns false if plan charges are not exportable for the specific merchant.

billingStartTimeinteger

Returns the time when a merchant's app trial ends and billing commences.

status'ACTIVE' | 'INACTIVE' | 'LAPSED' | 'SUPPRESSED'

Returns ACTIVE for an active Clover merchant when the merchant's bank account is in good standing. Returns INACTIVE if the merchant was offboarded. Returns LAPSED if the merchant failed to pay Clover for app usage. Returns SUPPRESSED if this merchant will not be billed for reasons such as it's a demo merchant account, test merchant account, or that the merchant’s country is a pilot.

daysLapsedinteger

Returns the number of days since the merchant's account was not in the ACTIVE status.