Commerce Subscription React Types

Error message if subscriptions can’t be fetched

Label for the Filter From date input

Label for the Filter To date input

Label for the My Subscriptions grid. Takes an isAccountContext boolean parameter.

Label for the search input

For the default column Subscription Name

For the default column Subscription Status

For the default column Subscription Created Date

For the default column Subscription Source Ref, e.g., Order Number

Represents any other messages passed in for custom columns

Represents any other messages passed in for custom subscription statuses

Label for the Active subscription status

Label for the Cancelled subscription status

Label for the Pending Cancellation subscription status

Label for the Paused subscription status

Label for the Error subscription status

Fallback message to use when a Subscription is missing a name. Takes created as Date variable

Represents any other messages passed in for custom subscription statuses

Label for the button leading back to the subscriptions browse view

Title for the detail page. Takes a name argument.

Label for the subscription’s termination date

Label for the subscription’s billing frequency

Label to translate the period type and frequency for display. Takes periodFrequency (number) and periodType (string) arguments.

Label for the subscription’s next bill date

Label if the subscription does not have a next bill date

Label for the subscription’s auto-renew status

Label for the subscription’s auto-renew status' value. Takes a boolean autoRenew argument.

Title for the subscription’s payment summary section

Title for the subscription’s subscription summary section

Label for the subscription’s payer’s email

Label for the subscription’s payment method

Label for the subscription’s source order number

Represents any other messages passed in for custom subscription statuses

Label for the Subscription Item Quantity in the details view. Takes a quantity argument.

Represents any other messages passed in for custom subscription statuses

Label for the subscription’s list of included items

Label for the quantity column of the included items list

Represents any other messages passed in for custom subscription statuses

Security scope(s) for customers to test access or get access tokens with

The URL host of the gateway application.

Preview options to include in requests when in sandbox-preview mode

URI that maps to the page to redirect to when modifying a subscription such as for edit, upgrade, or downgrade. This can be a PDP like page where the user can reconfigure their subscription product, or a page to select a product to upgrade or downgrade to.

Size of the page of subscriptions

URI that maps to the root subscription view context. Defaults to /my-account/subscriptions

URI that maps to the root orders view context. Defaults to /my-account/orders

Label for the edit subscription action

Label for the change auto-renewal status action

Label for the upgrade subscription action

Label for the downgrade subscription action

Label for the cancel subscription action

Label for the submit cancellation request action

Label for the cancel cancellation request action

Title for the cancel subscription modal

Message to display to the user asking if they are sure they want to cancel

Represents any other messages passed in for custom subscription statuses

The field to display in the column

Alias for the field to use when passing it as a sort param in requests. This is useful when the business domain uses a different field than the persistent domain.

The key for the message descriptor to use to label the field’s column

Whether the column is sortable

Label for the page number component. Typically used as the aria-label only.

Label for the next page button

Label for the previous page button