PayNow

StorefrontSubscriptionDto

Data transfer object representing a store subscription.

cancel_at_period_endbooleanRequired
Whether the subscription will be canceled at the end of the billing period.
coupon_idsFlakeId[]Required
Identifiers of coupons applied to this subscription.
created_atstringRequired
Date and time when the subscription was created.
currencystringRequired
Currency code used for billing this subscription.
customerStorefrontCustomerDtoRequired
A storefront representation of a customer in the PayNow system with their associated profiles and metadata.
idFlakeIdRequired
store_idFlakeIdRequired
minecraftStorefrontCustomerMinecraftProfileDtoOptional
A storefront representation of a customers Minecraft profile.
avatar_urlstringRequired
The URL to the player's Minecraft skin rendered as an avatar.
idstringRequired
The UUID of the Minecraft player. If the platform is Minecraft Offline, this will be the name itself. If the platform is Minecraft Geyser, and this is a Bedrock account, this ID will be an Xbox XUID.
namestringRequired
The username of the Minecraft player.
minecraft_platformenumOptional
Possible enum values
  • unknown
  • java
  • bedrock
minecraft_uuidstringOptional
The customer's Minecraft UUID, if they have linked their Minecraft account. Not set for offline Minecraft stores. If the platform type is Minecraft - Geyser, and the profile is a bedrock account, this will be a UUID generated from the Xbox XUID.
namestringOptional
The display name for the customer.
profileCustomerGenericProfileDtoOptional
Represents a generic platform profile for a customer.
idstringRequired
The platform-specific identifier for the profile.
namestringRequired
The display name of the user on this platform.
platformstringRequired
The name of the platform this profile belongs to.
avatar_urlstringOptional
The URL to the user's avatar image on this platform.
steamStorefrontCustomerSteamProfileDtoOptional
A storefront representation of a customers Steam profile.
avatar_urlstringRequired
The URL to the user's Steam avatar image.
idSteamIdRequired
A 64-bit Steam account identifier. Accepts string or numeric format.
namestringRequired
The display name of the user on Steam.
steam_idSteamIdOptional
A 64-bit Steam account identifier. Accepts string or numeric format.
xbox_xuidstringOptional
The customer's Xbox XUID, if available.
discount_amountintegerRequired
Amount of discount applied in smallest currency units.
discount_amount_strstringRequired
Formatted string representation of the discount amount.
idFlakeIdRequired
initial_discount_amountintegerRequired
Initial discount amount in the smallest currency units for the first billing cycle.
initial_discount_amount_strstringRequired
Formatted string representation of the initial discount amount.
initial_giftcard_usage_amountintegerRequired
Initial gift card usage amount in smallest currency units.
initial_giftcard_usage_amount_strstringRequired
Formatted string representation of the initial gift card usage amount.
initial_subtotal_amountintegerRequired
Initial subtotal amount in smallest currency units for the first billing cycle.
initial_subtotal_amount_strstringRequired
Formatted string representation of the initial subtotal amount.
initial_tax_amountintegerRequired
Initial tax amount in smallest currency units for the first billing cycle.
initial_tax_amount_strstringRequired
Formatted string representation of the initial tax amount.
initial_total_amountintegerRequired
Initial total amount in smallest currency units for the first billing cycle.
initial_total_amount_strstringRequired
Formatted string representation of the initial total amount.
interval_scaleenumRequired
Possible enum values
  • invalid
  • day
  • week
  • month
  • year
interval_valueintegerRequired
Numeric value of the billing interval.
linesStorefrontSubscriptionLineDto[]Required
Line items associated with this subscription.
currencystringRequired
Currency code for this subscription line.
discount_amountintegerRequired
Amount of discount applied in smallest currency units.
discount_amount_strstringRequired
Formatted string representation of the discount amount.
idFlakeIdRequired
initial_discount_amountintegerRequired
Initial discount amount in smallest currency units for the first billing cycle.
initial_discount_amount_strstringRequired
Formatted string representation of the initial discount amount.
initial_giftcard_usage_amountintegerRequired
Initial gift card usage amount in smallest currency units.
initial_giftcard_usage_amount_strstringRequired
Formatted string representation of the initial gift card usage amount.
initial_subtotal_amountintegerRequired
Initial subtotal amount in smallest currency units for the first billing cycle.
initial_subtotal_amount_strstringRequired
Formatted string representation of the initial subtotal amount.
initial_tax_amountintegerRequired
Initial tax amount in smallest currency units for the first billing cycle.
initial_tax_amount_strstringRequired
Formatted string representation of the initial tax amount.
initial_total_amountintegerRequired
Initial total amount in smallest currency units for the first billing cycle.
initial_total_amount_strstringRequired
Formatted string representation of the initial total amount.
priceintegerRequired
Base price of the subscription line in smallest currency units (e.g., cents).
product_idFlakeIdRequired
product_namestringRequired
Name of the product associated with this subscription line.
product_version_idFlakeIdRequired
store_idFlakeIdRequired
subscription_idFlakeIdRequired
subtotal_amountintegerRequired
Subtotal amount in smallest currency units.
subtotal_amount_strstringRequired
Formatted string representation of the subtotal amount.
tax_amountintegerRequired
Tax amount in smallest currency units.
tax_amount_strstringRequired
Formatted string representation of the tax amount.
tax_inclusivebooleanRequired
Indicates whether tax is included in the base price itself.
total_amountintegerRequired
Total amount in smallest currency units.
total_amount_strstringRequired
Formatted string representation of the total amount.
checkout_line_idFlakeIdOptional
gift_to_customer_idFlakeIdOptional
initial_order_line_idFlakeIdOptional
initial_presentment_discount_amountintegerOptional
Initial presentment discount amount in smallest currency units for the first billing cycle.
initial_presentment_discount_amount_strstringOptional
Formatted string representation of the initial presentment discount amount.
initial_presentment_giftcard_usage_amountintegerOptional
Initial presentment gift card usage amount in smallest currency units.
initial_presentment_giftcard_usage_amount_strstringOptional
Formatted string representation of the initial presentment gift card usage amount.
initial_presentment_subtotal_amountintegerOptional
Initial presentment subtotal amount in smallest currency units for the first billing cycle.
initial_presentment_subtotal_amount_strstringOptional
Formatted string representation of the initial presentment subtotal amount.
initial_presentment_tax_amountintegerOptional
Initial presentment tax amount in smallest currency units for the first billing cycle.
initial_presentment_tax_amount_strstringOptional
Formatted string representation of the initial presentment tax amount.
initial_presentment_total_amountintegerOptional
Initial presentment total amount in smallest currency units for the first billing cycle.
initial_presentment_total_amount_strstringOptional
Formatted string representation of the initial presentment total amount.
presentment_currencystringOptional
Presentment currency code (currency shown to customer).
presentment_discount_amountintegerOptional
Presentment discount amount in smallest currency units.
presentment_discount_amount_strstringOptional
Formatted string representation of the presentment discount amount.
presentment_subtotal_amountintegerOptional
Presentment subtotal amount in smallest currency units.
presentment_subtotal_amount_strstringOptional
Formatted string representation of the presentment subtotal amount.
presentment_tax_amountintegerOptional
Presentment tax amount in smallest currency units.
presentment_tax_amount_strstringOptional
Formatted string representation of the presentment tax amount.
presentment_total_amountintegerOptional
Presentment total amount in smallest currency units.
presentment_total_amount_strstringOptional
Formatted string representation of the presentment total amount.
pricing_region_idstringOptional
Identifier for the pricing region associated with this subscription line.
product_image_urlstringOptional
URL for the product image.
sale_idFlakeIdOptional
sale_version_idFlakeIdOptional
selected_gameserver_idFlakeIdOptional
trial_idFlakeIdOptional
next_billing_amountSubscriptionBillingAmountDtoRequired
Represents a billing amount breakdown for a subscription.
currencystringRequired
ISO 4217 currency code, in lowercase.
discountintegerRequired
Total discount applied, in smallest currency units.
subtotalintegerRequired
Base amount before discounts or tax, in smallest currency units.
taxintegerRequired
Tax amount, in smallest currency units.
totalintegerRequired
Amount due after discounts and tax, in smallest currency units.
next_billing_presentment_amountSubscriptionBillingAmountDtoRequired
Represents a billing amount breakdown for a subscription.
currencystringRequired
ISO 4217 currency code, in lowercase.
discountintegerRequired
Total discount applied, in smallest currency units.
subtotalintegerRequired
Base amount before discounts or tax, in smallest currency units.
taxintegerRequired
Tax amount, in smallest currency units.
totalintegerRequired
Amount due after discounts and tax, in smallest currency units.
past_duebooleanRequired
Whether the subscription is past due, and is in a dunning (retrying) state.
pretty_idstringRequired
Human-readable identifier for the subscription.
statusenumRequired
Represents the current state of a subscription.
Possible enum values
  • invalid
  • created

    The subscription has been created but is not yet active.

  • active

    The subscription is currently active and will renew.

  • canceled

    The subscription has been canceled and will no longer renew.

store_idFlakeIdRequired
subtotal_amountintegerRequired
Subtotal amount in smallest currency units.
subtotal_amount_strstringRequired
Formatted string representation of the subtotal amount.
tax_amountintegerRequired
Tax amount in the smallest currency units.
tax_amount_strstringRequired
Formatted string representation of the tax amount.
tax_jurisdictionsSalesTaxJurisdictionDto[]Required
List of tax jurisdictions applicable to this subscription.
namestringRequired
The name of the tax jurisdiction.
taxesSalesTaxJurisdictionTaxDto[]Required
List of taxes applied within this jurisdiction.
tax_amountstringRequired
The calculated tax amount, formatted as a string.
tax_namestringRequired
The name of the tax.
tax_ratestringRequired
The rate at which the tax is applied, formatted as a string.
taxable_amountstringRequired
The amount subject to taxation, formatted as a string.
not_taxed_reasonstringOptional
Explanation for why taxes are not applied, if applicable. This property is null when taxes are applied.
total_amountintegerRequired
Total amount in the smallest currency units.
total_amount_strstringRequired
Formatted string representation of the total amount.
active_atstringOptional
Date and time when the subscription became active.
attempt_countintegerOptional
Number of payment attempts made for the current billing cycle.
billing_cycle_sequenceintegerOptional
Sequence number of the current billing cycle.
cancel_reasonstringOptional
Reason provided for cancellation.
canceled_atstringOptional
Date and time when the subscription was canceled.
cancellation_requested_atstringOptional
Date and time when a subscription cancellation (cancel_at_period_end) was requested.
checkout_idFlakeIdOptional
current_period_endstringOptional
End date of the current billing period.
current_period_startstringOptional
Start date of the current billing period.
fx_ratestringOptional
The foreign exchange rate applied (if presentment currency differs from settlement currency).
initial_presentment_discount_amountintegerOptional
Initial presentment discount amount in smallest currency units for the first billing cycle.
initial_presentment_discount_amount_strstringOptional
Formatted string representation of the initial presentment discount amount.
initial_presentment_giftcard_usage_amountintegerOptional
Initial presentment gift card usage amount in smallest currency units.
initial_presentment_giftcard_usage_amount_strstringOptional
Formatted string representation of the initial presentment gift card usage amount.
initial_presentment_subtotal_amountintegerOptional
Initial presentment subtotal amount in smallest currency units for the first billing cycle.
initial_presentment_subtotal_amount_strstringOptional
Formatted string representation of the initial presentment subtotal amount.
initial_presentment_tax_amountintegerOptional
Initial presentment tax amount in smallest currency units for the first billing cycle.
initial_presentment_tax_amount_strstringOptional
Formatted string representation of the initial presentment tax amount.
initial_presentment_total_amountintegerOptional
Initial presentment total amount in smallest currency units for the first billing cycle.
initial_presentment_total_amount_strstringOptional
Formatted string representation of the initial presentment total amount.
next_attempt_atstringOptional
Date and time when the next payment attempt will occur.
pending_changeSubscriptionChangeDtoOptional
A pending or applied change to a subscription.
created_atstringRequired
idFlakeIdRequired
linesSubscriptionChangeLineDto[]Required
A single line item within a subscription change.
amountSubscriptionChangeLineAmountDtoRequired
→ SubscriptionChangeLineAmountDto
idFlakeIdRequired
is_deletedbooleanRequired
Whether this line is being removed by the change.
presentment_amountSubscriptionChangeLineAmountDtoRequired
→ SubscriptionChangeLineAmountDto
priceintegerRequired
Base price in smallest settlement currency units.
productSubscriptionChangeLineProductDtoRequired
→ SubscriptionChangeLineProductDto
prorated_amountintegerRequired
Prorated charge for this line in smallest settlement currency units.
prorated_presentment_amountintegerRequired
Prorated charge for this line in smallest presentment currency units.
remaining_minutesintegerRequired
Minutes remaining in the billing period at the time of change - used to calculate proration.
tax_inclusivebooleanRequired
Whether tax is included in the base price.
total_minutesintegerRequired
Total minutes in the billing period - used to calculate proration.
subscription_line_idFlakeIdOptional
next_billing_amountSubscriptionChangeAmountDtoRequired
Pricing breakdown for a subscription change, in the smallest units of the given currency (e.g. cents).
currencystringRequired
ISO 4217 currency code, in lowercase.
discountintegerRequired
Total discount applied, in smallest currency units.
subtotalintegerRequired
Base amount before discounts or tax, in smallest currency units.
taxintegerRequired
Tax amount, in smallest currency units.
totalintegerRequired
Amount due after discounts and tax, in smallest currency units.
next_billing_presentment_amountSubscriptionChangeAmountDtoRequired
Pricing breakdown for a subscription change, in the smallest units of the given currency (e.g. cents).
currencystringRequired
ISO 4217 currency code, in lowercase.
discountintegerRequired
Total discount applied, in smallest currency units.
subtotalintegerRequired
Base amount before discounts or tax, in smallest currency units.
taxintegerRequired
Tax amount, in smallest currency units.
totalintegerRequired
Amount due after discounts and tax, in smallest currency units.
off_sessionbooleanRequired
Whether this change was initiated without active customer interaction.
prorated_amountSubscriptionChangeProratedAmountDtoRequired
The total prorated charge for a subscription change, expressed in both settlement and presentment currencies.
currencystringRequired
ISO 4217 settlement currency code, in lowercase.
presentment_currencystringRequired
ISO 4217 presentment currency code, in lowercase.
presentment_prorated_amountintegerRequired
Total prorated charge in smallest presentment currency units, including tax.
prorated_amountintegerRequired
Total prorated charge in smallest settlement currency units, including tax.
proration_behaviorenumRequired
Describes how proration is handled when a subscription change is applied.
Possible enum values
  • invalid
  • immediate

    Subscription will be updated instantly, and a proration charge will be applied.

  • next_billing_period

    Subscription will be updated at the end of the billing period, no proration will be applied.

  • none

    No proration is applied, subscription is updated instantly.

statusenumRequired
Represents the status of a subscription change.
Possible enum values
  • invalid
  • pending_payment

    The change is pending payment before it can be applied.

  • pending_renewal

    The change will be applied at the next renewal.

  • applied

    The change has been applied to the subscription.

  • canceled

    The change was canceled and will not be applied.

  • pending_verification

    The change requires a verification code sent to the customer's e-mail.

subscription_idFlakeIdRequired
applied_atstringOptional
prorated_order_idFlakeIdOptional
presentment_currencystringOptional
Presentment currency code (currency shown to customer).
presentment_discount_amountintegerOptional
Presentment discount amount in smallest currency units.
presentment_discount_amount_strstringOptional
Formatted string representation of the presentment discount amount.
presentment_subtotal_amountintegerOptional
Presentment subtotal amount in smallest currency units.
presentment_subtotal_amount_strstringOptional
Formatted string representation of the presentment subtotal amount.
presentment_tax_amountintegerOptional
Presentment tax amount in smallest currency units.
presentment_tax_amount_strstringOptional
Formatted string representation of the presentment tax amount.
presentment_total_amountintegerOptional
Presentment total amount in smallest currency units.
presentment_total_amount_strstringOptional
Formatted string representation of the presentment total amount.
updated_atstringOptional
Date and time when the subscription was last updated.
Example
{
  "cancel_at_period_end": true,
  "coupon_ids": [
    "411486491630370816"
  ],
  "created_at": "2024-01-01T00:00:00Z",
  "currency": "string",
  "customer": {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "profile": {
      "id": "string",
      "name": "string",
      "platform": "steam",
      "avatar_url": "string"
    },
    "steam_id": "76561197960287930",
    "steam": {
      "avatar_url": "string",
      "id": "76561197960287930",
      "name": "string"
    },
    "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
    "minecraft": {
      "avatar_url": "string",
      "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "name": "notch"
    },
    "minecraft_platform": "unknown",
    "xbox_xuid": "string",
    "name": "m0uka"
  },
  "discount_amount": 0,
  "discount_amount_str": "string",
  "id": "411486491630370816",
  "initial_discount_amount": 0,
  "initial_discount_amount_str": "string",
  "initial_giftcard_usage_amount": 0,
  "initial_giftcard_usage_amount_str": "string",
  "initial_subtotal_amount": 0,
  "initial_subtotal_amount_str": "string",
  "initial_tax_amount": 0,
  "initial_tax_amount_str": "string",
  "initial_total_amount": 0,
  "initial_total_amount_str": "string",
  "interval_scale": "invalid",
  "interval_value": 0,
  "lines": [
    {
      "currency": "string",
      "discount_amount": 0,
      "discount_amount_str": "string",
      "id": "411486491630370816",
      "initial_discount_amount": 0,
      "initial_discount_amount_str": "string",
      "initial_giftcard_usage_amount": 0,
      "initial_giftcard_usage_amount_str": "string",
      "initial_subtotal_amount": 0,
      "initial_subtotal_amount_str": "string",
      "initial_tax_amount": 0,
      "initial_tax_amount_str": "string",
      "initial_total_amount": 0,
      "initial_total_amount_str": "string",
      "price": 0,
      "product_id": "411486491630370816",
      "product_name": "string",
      "product_version_id": "411486491630370816",
      "store_id": "411486491630370816",
      "subscription_id": "411486491630370816",
      "subtotal_amount": 0,
      "subtotal_amount_str": "string",
      "tax_amount": 0,
      "tax_amount_str": "string",
      "tax_inclusive": true,
      "total_amount": 0,
      "total_amount_str": "string",
      "checkout_line_id": "411486491630370816",
      "initial_order_line_id": "411486491630370816",
      "pricing_region_id": "string",
      "gift_to_customer_id": "411486491630370816",
      "selected_gameserver_id": "411486491630370816",
      "sale_id": "411486491630370816",
      "sale_version_id": "411486491630370816",
      "trial_id": "411486491630370816",
      "product_image_url": "string",
      "presentment_currency": "string",
      "presentment_subtotal_amount": 0,
      "presentment_subtotal_amount_str": "string",
      "presentment_discount_amount": 0,
      "presentment_discount_amount_str": "string",
      "presentment_tax_amount": 0,
      "presentment_tax_amount_str": "string",
      "presentment_total_amount": 0,
      "presentment_total_amount_str": "string",
      "initial_presentment_discount_amount": 0,
      "initial_presentment_discount_amount_str": "string",
      "initial_presentment_subtotal_amount": 0,
      "initial_presentment_subtotal_amount_str": "string",
      "initial_presentment_giftcard_usage_amount": 0,
      "initial_presentment_giftcard_usage_amount_str": "string",
      "initial_presentment_tax_amount": 0,
      "initial_presentment_tax_amount_str": "string",
      "initial_presentment_total_amount": 0,
      "initial_presentment_total_amount_str": "string"
    }
  ],
  "next_billing_amount": {
    "currency": "string",
    "discount": 0,
    "subtotal": 0,
    "tax": 0,
    "total": 0
  },
  "next_billing_presentment_amount": {
    "currency": "string",
    "discount": 0,
    "subtotal": 0,
    "tax": 0,
    "total": 0
  },
  "past_due": true,
  "pretty_id": "string",
  "status": "invalid",
  "store_id": "411486491630370816",
  "subtotal_amount": 0,
  "subtotal_amount_str": "string",
  "tax_amount": 0,
  "tax_amount_str": "string",
  "tax_jurisdictions": [
    {
      "name": "EU OSS",
      "taxes": [
        {
          "tax_amount": "string",
          "tax_name": "string",
          "tax_rate": "string",
          "taxable_amount": "string"
        }
      ],
      "not_taxed_reason": "string"
    }
  ],
  "total_amount": 0,
  "total_amount_str": "string",
  "pending_change": {
    "created_at": "2024-01-01T00:00:00Z",
    "id": "411486491630370816",
    "lines": [
      {
        "amount": {
          "currency": "string",
          "discount": 0,
          "subtotal": 0,
          "tax": 0,
          "total": 0
        },
        "id": "411486491630370816",
        "is_deleted": true,
        "presentment_amount": {
          "currency": "string",
          "discount": 0,
          "subtotal": 0,
          "tax": 0,
          "total": 0
        },
        "price": 0,
        "product": {
          "custom_variables": {},
          "id": "411486491630370816",
          "name": "string",
          "version_id": "411486491630370816",
          "image_url": "string",
          "selected_gameserver_id": "411486491630370816",
          "pricing_region_id": "string"
        },
        "prorated_amount": 0,
        "prorated_presentment_amount": 0,
        "remaining_minutes": 0,
        "tax_inclusive": true,
        "total_minutes": 0,
        "subscription_line_id": "411486491630370816"
      }
    ],
    "next_billing_amount": {
      "currency": "string",
      "discount": 0,
      "subtotal": 0,
      "tax": 0,
      "total": 0
    },
    "next_billing_presentment_amount": {
      "currency": "string",
      "discount": 0,
      "subtotal": 0,
      "tax": 0,
      "total": 0
    },
    "off_session": true,
    "prorated_amount": {
      "currency": "string",
      "presentment_currency": "string",
      "presentment_prorated_amount": 0,
      "prorated_amount": 0
    },
    "proration_behavior": "invalid",
    "status": "invalid",
    "subscription_id": "411486491630370816",
    "prorated_order_id": "411486491630370816",
    "applied_at": "2024-01-01T00:00:00Z"
  },
  "checkout_id": "411486491630370816",
  "presentment_currency": "string",
  "presentment_subtotal_amount": 0,
  "presentment_subtotal_amount_str": "string",
  "presentment_discount_amount": 0,
  "presentment_discount_amount_str": "string",
  "presentment_tax_amount": 0,
  "presentment_tax_amount_str": "string",
  "presentment_total_amount": 0,
  "presentment_total_amount_str": "string",
  "initial_presentment_discount_amount": 0,
  "initial_presentment_discount_amount_str": "string",
  "initial_presentment_subtotal_amount": 0,
  "initial_presentment_subtotal_amount_str": "string",
  "initial_presentment_giftcard_usage_amount": 0,
  "initial_presentment_giftcard_usage_amount_str": "string",
  "initial_presentment_tax_amount": 0,
  "initial_presentment_tax_amount_str": "string",
  "initial_presentment_total_amount": 0,
  "initial_presentment_total_amount_str": "string",
  "fx_rate": "string",
  "current_period_start": "2024-01-01T00:00:00Z",
  "current_period_end": "2024-01-01T00:00:00Z",
  "billing_cycle_sequence": 0,
  "next_attempt_at": "2024-01-01T00:00:00Z",
  "attempt_count": 0,
  "updated_at": "2024-01-01T00:00:00Z",
  "active_at": "2024-01-01T00:00:00Z",
  "canceled_at": "2024-01-01T00:00:00Z",
  "cancel_reason": "string",
  "cancellation_requested_at": "2024-01-01T00:00:00Z"
}