App
The information about the price that's charged to a shop every plan period.
The concrete type can be for recurring billing or for usage-based billing.
Anchor to Possible typesPossible types
- •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).
- Anchor to discountdiscount•App
Subscription Discount The discount applied to the subscription for a given number of billing intervals.
- Anchor to intervalinterval•App
Pricing Interval! non-null The frequency at which the subscribing shop is billed for an app subscription.
- Anchor to planHandleplan•String
Handle The app store pricing plan handle.
- Anchor to priceprice•Money
V2! 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.
- Anchor to balanceUsedbalance•Money
Used V2! non-null The total usage records for interval.
- Anchor to cappedAmountcapped•Money
Amount V2! 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.
- Anchor to intervalinterval•App
Pricing Interval! non-null The frequency with which the app usage records are billed.
- Anchor to termsterms•String!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.
Anchor to Fields with this unionFields with this union
- •OBJECT
The app plan that the merchant is subscribed to.