Skip to main content
Log inSign up

Shopify uses cookies to provide necessary site functionality and improve your experience. By using our website, you agree to our privacy policy and our cookie policy.

union

The information about the price that's charged to a shop every plan period. The concrete type can be AppRecurringPricing for recurring billing or AppUsagePricing for usage-based billing.

OBJECT

The pricing information about a subscription app. The object contains an interval (the frequency at which the shop is billed for an app subscription) and a price (the amount to be charged to the subscribing shop at each interval).

discount

The discount applied to the subscription for a given number of billing intervals.

interval
non-null

The frequency at which the subscribing shop is billed for an app subscription.

planHandle

The app store pricing plan handle.

planId

The app store pricing plan id.

price
non-null

The amount and currency to be charged to the subscribing shop every billing interval.

OBJECT

Defines a usage pricing model for the app subscription. These charges are variable based on how much the merchant uses the app.

balanceUsed
non-null

The total usage records for interval.

cappedAmount
non-null

The capped amount prevents the merchant from being charged for any usage over that amount during a billing period. This prevents billing from exceeding a maximum threshold over the duration of the billing period. For the merchant to continue using the app after exceeding a capped amount, they would need to agree to a new usage charge.

interval
non-null

The frequency with which the app usage records are billed.

terms
non-null

The terms and conditions for app usage pricing. Must be present in order to create usage charges. The terms are presented to the merchant when they approve an app's usage charges.


Was this section helpful?

Anchor to Fields with this unionFields with this union

OBJECT

The plan billed to a shop on a recurring basis.


Was this section helpful?