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

SubscriptionUpdateRequest

Update request for a subscription.

namestringOptional

The name of the subscription.

start_datestring<DateTimeWithZone>Optional

Date and time in ISO 8601 format.

Formatdate-time

end_datestring<DateTimeWithZone>Optional

Date and time in ISO 8601 format.

Formatdate-time

statusenum<SubscriptionStatus>Optional

The status of the subscription

Value in"PENDING" | "ACTIVE" | "TERMINATED" | "CANCELED"

plan_overridesobject<PlanOverridesUpdateRequest>Optional

PlanOverridesUpdateRequest properties

7 properties

amountobject<AmountNoCurrency>Optional

AmountNoCurrency properties

1 property

valuenumberRequired

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

Default0FormatdecimalRange0 <= value <= ∞

descriptionstringOptional

The description on the plan

invoice_display_namestringOptional

Specifies the name that will appear on the invoice

namestringOptional

The name of the plan

chargesobject<SubscriptionUsageBasedCharge>[]Optional

SubscriptionUsageBasedCharge properties

3 properties

idstringRequired

Unique identifier of the charge

tax_codesarray<string>Optional

List of unique codes used to identify taxes to be applied.

propertiesobjectOptional

Pricing thresholds that determine the charges

minimum_commitmentobject<MinimumCommitmentRequest>Optional

Minimum commitment for this plan.

MinimumCommitmentRequest properties

3 properties

amountobject<AmountNoCurrency>Required

AmountNoCurrency properties

1 property

valuenumberRequired

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

Default0FormatdecimalRange0 <= value <= ∞

invoice_display_namestringOptional

Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.

tax_codesarray<string>Optional

List of unique codes used to identify taxes to be applied.

tax_codesarray<string>Optional

List of unique codes used to identify taxes to be applied.

Back to top

SubscriptionUpdateRequest

Update request for a subscription.

namestringOptional

The name of the subscription.

start_datestring<DateTimeWithZone>Optional

Date and time in ISO 8601 format.

Formatdate-time

end_datestring<DateTimeWithZone>Optional

Date and time in ISO 8601 format.

Formatdate-time

statusenum<SubscriptionStatus>Optional

The status of the subscription

Value in"PENDING" | "ACTIVE" | "TERMINATED" | "CANCELED"

plan_overridesobject<PlanOverridesUpdateRequest>Optional

PlanOverridesUpdateRequest properties

7 properties

amountobject<AmountNoCurrency>Optional

AmountNoCurrency properties

1 property

valuenumberRequired

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

Default0FormatdecimalRange0 <= value <= ∞

descriptionstringOptional

The description on the plan

invoice_display_namestringOptional

Specifies the name that will appear on the invoice

namestringOptional

The name of the plan

chargesobject<SubscriptionUsageBasedCharge>[]Optional

SubscriptionUsageBasedCharge properties

3 properties

idstringRequired

Unique identifier of the charge

tax_codesarray<string>Optional

List of unique codes used to identify taxes to be applied.

propertiesobjectOptional

Pricing thresholds that determine the charges

minimum_commitmentobject<MinimumCommitmentRequest>Optional

Minimum commitment for this plan.

MinimumCommitmentRequest properties

3 properties

amountobject<AmountNoCurrency>Required

AmountNoCurrency properties

1 property

valuenumberRequired

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

Default0FormatdecimalRange0 <= value <= ∞

invoice_display_namestringOptional

Specifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.

tax_codesarray<string>Optional

List of unique codes used to identify taxes to be applied.

tax_codesarray<string>Optional

List of unique codes used to identify taxes to be applied.

SubscriptionUpdateRequest

PlanOverridesUpdateRequest properties

AmountNoCurrency properties

SubscriptionUsageBasedCharge properties

MinimumCommitmentRequest properties

AmountNoCurrency properties

Back to top

On this page

On this page

SubscriptionUpdateRequest

PlanOverridesUpdateRequest properties

AmountNoCurrency properties

SubscriptionUsageBasedCharge properties

MinimumCommitmentRequest properties

AmountNoCurrency properties

Back to top

On this page

SubscriptionUpdateRequest

PlanOverridesUpdateRequest properties

AmountNoCurrency properties

SubscriptionUsageBasedCharge properties

MinimumCommitmentRequest properties

AmountNoCurrency 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

SubscriptionUpdateRequest

PlanOverridesUpdateRequest properties

AmountNoCurrency properties

SubscriptionUsageBasedCharge properties

MinimumCommitmentRequest properties

AmountNoCurrency properties

Back to top

On this page