Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

GrossRevenues

Represents a collection of monthly gross revenue records for a specific customer.

gross_revenuesobject<GrossRevenue>[]Optional

An array of monthly gross revenue entries for the specified customer.

GrossRevenue properties

3 properties

monthstring<DateYearMonth>Optional

The year and month, represented as a string in ISO 8601 'YYYY-MM' format (e.g., '2025-08'). For details, refer to RFC 3339 section 5.6 (Internet Date/Time Format).

Match^[0-9]{4}-(0[1-9]|1[0-2])$Length7 <= length <= 7

amountobject<Amount>Optional

The total gross revenue amount for the specified customer during the reference month.

Amount properties

2 properties

valuenumberRequired

The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).

Default0FormatdecimalRange0 <= value <= ∞

currency_codestring<Currency>Required

Currency code in ISO 4217 format.

Match^[A-Z]{3}$Length3 <= length <= 3

invoices_countintegerOptional

The number of invoices included in the gross revenue calculation for the reference month.

Back to top

GrossRevenues

Represents a collection of monthly gross revenue records for a specific customer.

gross_revenuesobject<GrossRevenue>[]Optional

An array of monthly gross revenue entries for the specified customer.

GrossRevenue properties

3 properties

monthstring<DateYearMonth>Optional

The year and month, represented as a string in ISO 8601 'YYYY-MM' format (e.g., '2025-08'). For details, refer to RFC 3339 section 5.6 (Internet Date/Time Format).

Match^[0-9]{4}-(0[1-9]|1[0-2])$Length7 <= length <= 7

amountobject<Amount>Optional

The total gross revenue amount for the specified customer during the reference month.

Amount properties

2 properties

valuenumberRequired

The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).

Default0FormatdecimalRange0 <= value <= ∞

currency_codestring<Currency>Required

Currency code in ISO 4217 format.

Match^[A-Z]{3}$Length3 <= length <= 3

invoices_countintegerOptional

The number of invoices included in the gross revenue calculation for the reference month.

GrossRevenues

GrossRevenue properties

Amount properties

Back to top

On this page

On this page

GrossRevenues

GrossRevenue properties

Amount properties

Back to top

On this page

GrossRevenues

GrossRevenue properties

Amount properties

Back to top

On this page

On this page

We currently use cookies to improve and customize your experience on our site. If you accept, we’ll also use marketing cookies to show you personalized ads. Manage your cookies and learn more.

GrossRevenues

GrossRevenue properties

Amount properties

Back to top

On this page