---
title: "Retrieve a proforma invoice"
method: GET
path: "/subscriptions/proformaInvoice/{subscription_id}"
tags: ["Subscriptions"]
---

# Retrieve a proforma invoice

`GET /subscriptions/proformaInvoice/{subscription_id}`

Retrieves a proforma invoice for the given `subscription_id`.

The invoice FastSpring returns provides an estimate of charges for the upcoming billing period, without taking into account any proposed changes to the plan.

## Path parameters

- `subscription_id` string, required

## Query parameters

- `lang` 'ar' | 'cs' | 'da' | 'de' | 'en' | 'es' | 'fi' | 'fr' | 'he' | 'hr' | 'it' | 'ja' | 'ko' | 'nl' | 'no' | 'pl' | 'pt' | 'ru' | 'sk' | 'sv' | 'tr' | 'zh'

## Response `200`

OK

- ProformaInvoiceResponse
  - `proformaInvoiceHeader` object — Header details of the proforma invoice.
    - `currency` string — Currency in which the proforma invoice was generated.
    - `timezone` string — Timezone of the invoice generation.
    - `language` string — Language of the proforma invoice.
    - `message` string — Message regarding the validity of the invoice.
    - `proFormaInvoiceCreationDate` integer — Creation date of the proforma invoice in epoch milliseconds.
    - `proFormaInvoiceCreationDateDisplay` string — Creation date of the proforma invoice in human-readable format.
    - `proFormaInvoiceCreationDateDisplayISO8601` string — Creation date of the proforma invoice in ISO 8601 format.
    - `proFormaInvoiceExpirationDate` integer — Expiration date of the proforma invoice in epoch milliseconds.
    - `proFormaInvoiceExpirationDateDisplay` string — Expiration date of the proforma invoice in human-readable format.
    - `proFormaInvoiceExpirationDateDisplayISO8601` string — Expiration date of the proforma invoice in ISO 8601 format.
  - `supportContact` object — Support contact details.
    - `name` string — Name of the support contact.
    - `email` string — Email address of the support contact.
    - `url` string — Website of the support contact.
  - `merchantContact` object — Merchant contact details.
    - `merchantName` string — Name of the merchant.
    - `merchantAddress` string — Address of the merchant.
  - `contact` object — Customer contact details.
    - `email` string — Email address of the customer.
    - `firstName` string — First name of the customer.
    - `phone` string — Phone number of the customer.
    - `company` string — Company name of the customer.
    - `address` object — Customer address.
      - `accountId` string — Account ID of the customer.
      - `addressLine1` string — First line of the address.
      - `city` string — City of the address.
      - `region` string — Region or state of the address.
      - `postalCode` string — Postal code of the address.
      - `country` string — Country of the address.
  - `items` object — Details of the items in the proforma invoice.
    - `subscription` string — Unique identifier for the subscription.
    - `currency` string — Currency of the items.
    - `timezone` string — Timezone of the items.
    - `periodStartDate` integer — Start date of the period in epoch milliseconds.
    - `periodStartDateDisplay` string — Human-readable format of the start date.
    - `periodStartDateDisplayISO8601` string — ISO 8601 format of the start date.
    - `periodEndDate` integer — End date of the period in epoch milliseconds.
    - `periodEndDateDisplay` string — Human-readable format of the end date.
    - `periodEndDateDisplayISO8601` string — End date of the period in ISO 8601 format.
    - `endDate` string — End date of the subscription.
    - `endDateDisplay` string — End date of the subscription in human-readable format.
    - `endDateDisplayISO8601` string — End date of the subscription in ISO 8601 format.
    - `remainingPeriods` integer — Number of remaining periods.
    - `nextChargeDate` integer — Next charge date in epoch milliseconds.
    - `nextChargeDateDisplay` string — Next charge date in human-readable format.
    - `nextChargeDateDisplayISO8601` string — Next charge date in ISO 8601 format.
    - `isProratable` boolean — Indicates if the subscription is proratable.
    - `prorationStatus` string — Proration status of the subscription.
    - `currentPlan` object — Current plan details.
      - `display` string — Display name of the current plan.
      - `product` string — Product code of the current plan.
      - `billingFrequency` string — Billing frequency of the current plan.
      - `price` number — Price of the current plan.
      - `priceDisplay` string — Price display of the current plan.
      - `discount` number — Discount on the current plan.
      - `discountDisplay` string — Discount display on the current plan.
      - `discounts` DiscountAddOn[] — List of discounts applied.
        - `applyDiscountImmediately` boolean — Indicates if the discount is applied immediately.
        - `discountPath` string — Path to the discount source, either product path or coupon code.
        - `discountDuration` string — Duration of the discount in billing periods. Null if indefinite.
        - `percentValue` number, float — Percentage value of the discount.
        - `discountValue` number, float — Fixed amount discount value.
      - `quantity` integer — Quantity of the current plan.
      - `subtotal` number — Subtotal amount of the current plan.
      - `subtotalDisplay` string — Subtotal display amount of the current plan.
      - `tax` number — Tax amount of the current plan.
      - `taxDisplay` string — Tax display amount of the current plan.
      - `total` number — Total amount of the current plan.
      - `totalDisplay` string — Total display amount of the current plan.
      - `taxPercent` number — Tax percentage of the current plan.
      - `taxPercentDisplay` string — Tax percentage display of the current plan.
      - `periodStartDate` integer — Start date of the period in epoch milliseconds.
      - `periodStartDateDisplay` string — Start date of the period in human-readable format.
      - `periodStartDateDisplayISO8601` string — Start date of the period in ISO 8601 format.
      - `periodEndDate` integer — End date of the period in epoch milliseconds.
      - `periodEndDateDisplay` string — End date of the period in human-readable format.
      - `periodEndDateDisplayISO8601` string — End date of the period in ISO 8601 format.
      - `prorationUtilizedDays` integer — Number of utilized proration days.
      - `prorationRemainingDays` integer — Number of remaining proration days.
      - `prorationTotalDays` integer — Total number of proration days.
      - `proratedItemCharge` number — Prorated item charge amount.
      - `proratedItemChargeDisplay` string — Prorated item charge display amount.
      - `proratedItemCredit` number — Prorated item credit amount.
      - `proratedItemCreditDisplay` string — Prorated item credit display amount.
      - `proratedItemSubtotal` number — Prorated item subtotal amount.
      - `proratedItemSubtotalDisplay` string — Prorated item subtotal display amount.
      - `proratedItemTax` number — Prorated item tax amount.
      - `proratedItemTaxDisplay` string — Prorated item tax display amount.
      - `proratedItemTotal` number — Prorated item total amount.
      - `proratedItemTotalDisplay` string — Prorated item total display amount.
      - `addons` object[] — List of add-ons.
        - `display` string — Display name of the add-on.
        - `product` string — Product code of the add-on.
        - `price` number — Price of the add-on.
        - `priceDisplay` string — Price display of the add-on.
        - `discount` number — Discount on the add-on.
        - `discountDisplay` string — Discount display of the add-on.
        - `discounts` DiscountAddOn[] — List of discounts applied to the add-on.
          - `applyDiscountImmediately` boolean — Indicates if the discount is applied immediately.
          - `discountPath` string — Path to the discount source, either product path or coupon code.
          - `discountDuration` string — Duration of the discount in billing periods. Null if indefinite.
          - `percentValue` number, float — Percentage value of the discount.
          - `discountValue` number, float — Fixed amount discount value.
        - `quantity` integer — Quantity of the add-on.
        - `subtotal` number — Subtotal amount of the add-on.
        - `subtotalDisplay` string — Subtotal display amount of the add-on.
        - `tax` number — Tax amount of the add-on.
        - `taxDisplay` string — Tax display amount of the add-on.
        - `total` number — Total amount of the add-on.
        - `totalDisplay` string — Total display amount of the add-on.
        - `taxPercent` number — Tax percentage of the add-on.
        - `taxPercentDisplay` string — Tax percentage display of the add-on.
        - `proratedItemCharge` number — Prorated item charge amount.
        - `proratedItemChargeDisplay` string — Prorated item charge display amount.
        - `proratedItemCredit` number — Prorated item credit amount.
        - `proratedItemCreditDisplay` string — Prorated item credit display amount.
        - `proratedItemSubtotal` number — Prorated item subtotal amount.
        - `proratedItemSubtotalDisplay` string — Prorated item subtotal display amount.
        - `proratedItemTax` number — Prorated item tax amount.
        - `proratedItemTaxDisplay` string — Prorated item tax display amount.
        - `proratedItemTotal` number — Prorated item total amount.
        - `proratedItemTotalDisplay` string — Prorated item total display amount.
      - `subscriptionSubtotal` number — Subtotal amount of the subscription.
      - `subscriptionSubtotalDisplay` string — Subtotal display amount of the subscription.
      - `subscriptionTax` number — Tax amount of the subscription.
      - `subscriptionTaxDisplay` string — Tax display amount of the subscription.
      - `subscriptionTotal` number — Total amount of the subscription.
      - `subscriptionTotalDisplay` string — Total display amount of the subscription.
      - `subscriptionProratedCharge` number — Prorated charge amount of the subscription.
      - `subscriptionProratedChargeDisplay` string — Prorated charge display amount of the subscription.
      - `subscriptionProratedCredit` number — Prorated credit amount of the subscription.
      - `subscriptionProratedCreditDisplay` string — Prorated credit display amount of the subscription.
    - `proposedPlan` object — Proposed plan details.
      - `display` string — Display name of the proposed plan.
      - `product` string — Product code of the proposed plan.
      - `billingFrequency` string — Billing frequency of the proposed plan.
      - `price` number — Price of the proposed plan.
      - `priceDisplay` string — Price display of the proposed plan.
      - `discount` number — Discount on the proposed plan.
      - `discountDisplay` string — Discount display on the proposed plan.
      - `discounts` DiscountAddOn[] — List of discounts applied to the proposed plan.
        - `applyDiscountImmediately` boolean — Indicates if the discount is applied immediately.
        - `discountPath` string — Path to the discount source, either product path or coupon code.
        - `discountDuration` string — Duration of the discount in billing periods. Null if indefinite.
        - `percentValue` number, float — Percentage value of the discount.
        - `discountValue` number, float — Fixed amount discount value.
      - `quantity` integer — Quantity of the proposed plan.
      - `subtotal` number — Subtotal amount of the proposed plan.
      - `subtotalDisplay` string — Subtotal display amount of the proposed plan.
      - `tax` number — Tax amount of the proposed plan.
      - `taxDisplay` string — Tax display amount of the proposed plan.
      - `total` number — Total amount of the proposed plan.
      - `totalDisplay` string — Total display amount of the proposed plan.
      - `taxPercent` number — Tax percentage of the proposed plan.
      - `taxPercentDisplay` string — Tax percentage display of the proposed plan.
      - `periodStartDate` integer — Start date of the period in epoch milliseconds.
      - `periodStartDateDisplay` string — Start date of the period in human-readable format.
      - `periodStartDateDisplayISO8601` string — Start date of the period in ISO 8601 format.
      - `periodEndDate` integer — End date of the period in epoch milliseconds.
      - `periodEndDateDisplay` string — End date of the period in human-readable format.
      - `periodEndDateDisplayISO8601` string — End date of the period in ISO 8601 format.
      - `prorationUtilizedDays` integer — Number of utilized proration days.
      - `prorationRemainingDays` integer — Number of remaining proration days.
      - `prorationTotalDays` integer — Total number of proration days.
      - `proratedItemCharge` number — Prorated item charge amount.
      - `proratedItemChargeDisplay` string — Prorated item charge display amount.
      - `proratedItemCredit` number — Prorated item credit amount.
      - `proratedItemCreditDisplay` string — Prorated item credit display amount.
      - `proratedItemSubtotal` number — Prorated item subtotal amount.
      - `proratedItemSubtotalDisplay` string — Prorated item subtotal display amount.
      - `proratedItemTax` number — Prorated item tax amount.
      - `proratedItemTaxDisplay` string — Prorated item tax display amount.
      - `proratedItemTotal` number — Prorated item total amount.
      - `proratedItemTotalDisplay` string — Prorated item total display amount.
      - `addons` object[] — List of add-ons.
        - `display` string — Display name of the add-on.
        - `product` string — Product code of the add-on.
        - `price` number — Price of the add-on.
        - `priceDisplay` string — Price display of the add-on.
        - `discount` number — Discount on the add-on.
        - `discountDisplay` string — Discount display of the add-on.
        - `discounts` DiscountAddOn[] — List of discounts applied to the add-on.
          - `applyDiscountImmediately` boolean — Indicates if the discount is applied immediately.
          - `discountPath` string — Path to the discount source, either product path or coupon code.
          - `discountDuration` string — Duration of the discount in billing periods. Null if indefinite.
          - `percentValue` number, float — Percentage value of the discount.
          - `discountValue` number, float — Fixed amount discount value.
        - `quantity` integer — Quantity of the add-on.
        - `subtotal` number — Subtotal amount of the add-on.
        - `subtotalDisplay` string — Subtotal display amount of the add-on.
        - `tax` number — Tax amount of the add-on.
        - `taxDisplay` string — Tax display amount of the add-on.
        - `total` number — Total amount of the add-on.
        - `totalDisplay` string — Total display amount of the add-on.
        - `taxPercent` number — Tax percentage of the add-on.
        - `taxPercentDisplay` string — Tax percentage display of the add-on.
        - `proratedItemCharge` number — Prorated item charge amount.
        - `proratedItemChargeDisplay` string — Prorated item charge display amount.
        - `proratedItemCredit` number — Prorated item credit amount.
        - `proratedItemCreditDisplay` string — Prorated item credit display amount.
        - `proratedItemSubtotal` number — Prorated item subtotal amount.
        - `proratedItemSubtotalDisplay` string — Prorated item subtotal display amount.
        - `proratedItemTax` number — Prorated item tax amount.
        - `proratedItemTaxDisplay` string — Prorated item tax display amount.
        - `proratedItemTotal` number — Prorated item total amount.
        - `proratedItemTotalDisplay` string — Prorated item total display amount.
      - `subscriptionSubtotal` number — Subtotal amount of the subscription.
      - `subscriptionSubtotalDisplay` string — Subtotal display amount of the subscription.
      - `subscriptionTax` number — Tax amount of the subscription.
      - `subscriptionTaxDisplay` string — Tax display amount of the subscription.
      - `subscriptionTotal` number — Total amount of the subscription.
      - `subscriptionTotalDisplay` string — Total display amount of the subscription.
      - `subscriptionProratedCharge` number — Prorated charge amount of the subscription.
      - `subscriptionProratedChargeDisplay` string — Prorated charge display amount of the subscription.
      - `subscriptionProratedCredit` number — Prorated credit amount of the subscription.
      - `subscriptionProratedCreditDisplay` string — Prorated credit display amount of the subscription.
    - `amountDue` object — Details of the amount due.
      - `prorationSubtotal` number — Proration subtotal amount.
      - `prorationSubtotalDisplay` string — Proration subtotal display amount.
      - `prorationTax` number — Proration tax amount.
      - `prorationTaxDisplay` string — Proration tax display amount.
      - `totalAmountDue` number — Total amount due.
      - `totalAmountDueDisplay` string — Total amount due display.
      - `nextChargeDate` integer — Next charge date in epoch milliseconds.
      - `nextChargeDateDisplay` string — Next charge date in human-readable format.
      - `nextChargeDateDisplayISO8601` string — Next charge date in ISO 8601 format.
      - `nextChargeAmount` number — Next charge amount.
      - `nextChargeAmountDisplay` string — Next charge amount display.

## Other responses

- `400` — Bad Request
- `401` — Authentication credentials are missing or invalid.
- `404` — Subscription Not Found
- `405` — Method Not Allowed
- `429` — Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header.
- `500` — Internal Server Error

---

[API](https://skmtc.net/fastspring/apis/fastspring-api-accounts.md) · [All operations](https://skmtc.net/fastspring/apis/fastspring-api-accounts/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fastspring/fastspring-api-accounts/versions/ae2f0b97db3e/schema)