Business Platforms and marketplacesPlatforms Enterprise

Business Platforms and marketplaces Enterprise

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

CustomerChargeUsage

unitsstringRequired

The number of units utilized for a specific charge item.

Match^[0-9]+.?[0-9]*$

events_countintegerRequired

The total count of usage events that have been recorded for a particular charge during the specified time period.

amountobject<Amount>Required

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

chargeobject<UsageBasedCharge>Required

UsageBasedCharge properties

6 properties

idstringRequired

Unique identifier of the charge

metric_idstringRequired

Unique identifier of the metric

charge_modelenum<ChargeModel>Optional

Defines the pricing model to calculate the charge

Default"STANDARD"Value in"STANDARD" | "GRADUATED" | "PACKAGE" | "PERCENTAGE" | "VOLUME"

propertiesobjectOptional

Pricing thresholds that determine the charges

taxesobject<TaxResponse>[]Optional

List of tax entities configured for the usage based charge.

TaxResponse properties

6 properties

namestringRequired

Name of the tax

ratestringOptional

The percentage rate of the tax applied to transactions. A decimal amount from 0.01 to 100.00 inclusive, always with exactly two decimal places, no leading zeros except 0.xx.

Match^(?!0+(?:\.0+)?$)(?:0?\.\d{1,2}|[1-9]\d?(?:\.\d{1,2})?|100(?:\.0{1,2})?)$

descriptionstringOptional

Detailed description of the tax for internal reference

codestring<TaxCode>Optional

Unique code used to identify the tax. Must contain only alphanumeric characters, underscores, and hyphens.

Match^[a-zA-Z0-9_-]*$

idstringOptional

Unique identifier of the tax

Formatuuid

created_atstring<DateTimeWithZone>Optional

Date and time in ISO 8601 format.

Formatdate-time

min_amountobject<Amount>Optional

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

metricobject<CustomerUsageMetric>Required

Represents a metric used for customer usage. It includes the name, code, and aggregation type of the metric.

CustomerUsageMetric properties

3 properties

namestringRequired

Name of the metric used for this charge.

codestringRequired

Unique code identifying the metric used for this charge.

aggregation_typeenum<string | null>Required

Aggregation type for the metric

Value in"COUNT" | "SUM" | "MAX" | "COUNT_DISTINCT" | "LATEST"

Back to top

CustomerChargeUsage

unitsstringRequired

The number of units utilized for a specific charge item.

Match^[0-9]+.?[0-9]*$

events_countintegerRequired

The total count of usage events that have been recorded for a particular charge during the specified time period.

amountobject<Amount>Required

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

chargeobject<UsageBasedCharge>Required

UsageBasedCharge properties

6 properties

idstringRequired

Unique identifier of the charge

metric_idstringRequired

Unique identifier of the metric

charge_modelenum<ChargeModel>Optional

Defines the pricing model to calculate the charge

Default"STANDARD"Value in"STANDARD" | "GRADUATED" | "PACKAGE" | "PERCENTAGE" | "VOLUME"

propertiesobjectOptional

Pricing thresholds that determine the charges

taxesobject<TaxResponse>[]Optional

List of tax entities configured for the usage based charge.

TaxResponse properties

6 properties

namestringRequired

Name of the tax

ratestringOptional

The percentage rate of the tax applied to transactions. A decimal amount from 0.01 to 100.00 inclusive, always with exactly two decimal places, no leading zeros except 0.xx.

Match^(?!0+(?:\.0+)?$)(?:0?\.\d{1,2}|[1-9]\d?(?:\.\d{1,2})?|100(?:\.0{1,2})?)$

descriptionstringOptional

Detailed description of the tax for internal reference

codestring<TaxCode>Optional

Unique code used to identify the tax. Must contain only alphanumeric characters, underscores, and hyphens.

Match^[a-zA-Z0-9_-]*$

idstringOptional

Unique identifier of the tax

Formatuuid

created_atstring<DateTimeWithZone>Optional

Date and time in ISO 8601 format.

Formatdate-time

min_amountobject<Amount>Optional

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

metricobject<CustomerUsageMetric>Required

Represents a metric used for customer usage. It includes the name, code, and aggregation type of the metric.

CustomerUsageMetric properties

3 properties

namestringRequired

Name of the metric used for this charge.

codestringRequired

Unique code identifying the metric used for this charge.

aggregation_typeenum<string | null>Required

Aggregation type for the metric

Value in"COUNT" | "SUM" | "MAX" | "COUNT_DISTINCT" | "LATEST"

CustomerChargeUsage

Amount properties

UsageBasedCharge properties

TaxResponse properties

Amount properties

CustomerUsageMetric properties

Back to top

On this page

On this page

CustomerChargeUsage

Amount properties

UsageBasedCharge properties

TaxResponse properties

Amount properties

CustomerUsageMetric properties

Back to top

On this page

CustomerChargeUsage

Amount properties

UsageBasedCharge properties

TaxResponse properties

Amount properties

CustomerUsageMetric properties

Back to top

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

CustomerChargeUsage

Amount properties

UsageBasedCharge properties

TaxResponse properties

Amount properties

CustomerUsageMetric properties

Back to top

On this page