---
title: "Get Purchase V1"
method: GET
path: "/purchase/getpurchase"
tags: ["Purchase API"]
---

# Get Purchase V1

`GET /purchase/getpurchase`

<b>Important</b>: This endpoint has been deprecated. It is recommended that you use [Get Purchase V2](https://dev.cleverbridge.com/reference/purchase_getpurchasev2) if you want to make a new integration with this resource.<br />Retrieves all information about a particular purchase. When you make a call, you get a <code>Purchase</code> object that contains general purchase information, purchase item information, and other customized data (for example, x-parameters and license keys).<br />For XML examples and schemas, see the [Additional Examples - Get Purchase V1](https://dev.cleverbridge.com/page/additional-examples-get-purchase).

## Query parameters

- `purchaseId` string, required
- `reimbursementId` string

## Headers

- `Accept` 'application/json' | 'application/xml'

## Response `200`

OK

- CleverbridgeBackEndRestApiPurchaseClassesGetPurchaseResponseObject
  - `Purchase` CleverbridgeBackEndRestApiPurchaseClassesPurchaseObject — The purchase.
    - `PaidOrderNotification` CleverbridgeBackEndRestApiPurchaseClassesPaidOrderNotification — All information found in the <code>PaidOrderNotification</code>. Cleverbridge originally sent this notification when payment was received.
      - `Additionals` string — Additional information about the transaction.
      - `BillingContact` CleverbridgeBackEndRestApiPurchaseClassesBillingContact — Contact's billing information. For descriptions of the response items, see [Additional Purchase Response Items](https://dev.cleverbridge.com/page/additional-purchase-response-items).
        - `City` string — Contact's city.
        - `Company` string — Name of the company (if applicable).
        - `CompanyKatakana` string — Name of the company in Katakana (if applicable).
        - `CompanyRomanized` string — Romanized name of the company (if applicable).
        - `CompanyTypeId` 'COM' | 'GOV' | 'MIS' | 'NPR' | 'UNI' — ID of the company type. Possible values are Company = <code>COM</code>, Governmental = <code>GOV</code>, Miscellaneous = <code>MIS</code>, Non-profit = <code>NPR</code> and School/University = <code>UNI</code>.
        - `CountryId` string, required — Two-character ID of the contact's country. Submit with capital letters, for example <code>US</code>. See [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
        - `EMail` string — Contact's email address. Note: Cleverbridge has no pattern checking and does not validate email addresses.
        - `Fax` string — Contact's fax number.
        - `Firstname` string — Contact's first name.
        - `FirstnameKatakana` string — Contact's first name in Katakana.
        - `FirstnameRomanized` string — Contact's romanized first name.
        - `LanguageId` string, required — Two-character ID of the contact's language, see [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1). You must submit this with lower-case letters, for example <code>en</code>.
        - `Lastname` string — Contact's last name.
        - `LastnameKatakana` string — Contact's last name in Katakana.
        - `LastnameRomanized` string — Contact's romanized last name.
        - `Phone1` string — Contact's phone number.
        - `Phone2` string — Contact's additional phone number.
        - `PostalCode` string — Contact's postal code.
        - `SalutationId` 'MR_' | 'MS_' | 'MRS.' | 'MIS' — Contact's salutation. Possible values are Mr. = <code>MR_</code>, Ms. = <code>MS_</code>, Mrs. = <code>MRS</code>, Miss = <code>MIS</code>.
        - `StateId` string — Five- or six-character ID of the customer's country and state based on [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). It is required for Australia, Brazil, Canada, India, Ireland, Japan, the UAE, and the USA. For syntax, see [GraphQL StateEnum](https://docs.cleverbridge.com/api-documentation/graphql-api/doc/schema/stateenum.doc.html).
        - `Street1` string — Contact's street address.
        - `Street2` string — Contact's additional street information.
        - `Title` string — Contact's title.
        - `Url` string — Contact's website URL.
        - `VatId` string — Taxation number of the contact's company. It must be up-to-date, accurate, and correspond with the <code>CountryId</code>.
      - `CreationTime` string — Date and time when purchase was created according to [RFC3339](https://www.rfc-editor.org/info/rfc3339).
      - `CustomerConfirmationPageUrl` string — URL where the customer's confirmation page is located.
      - `CustomerPdfDocumentUrl` string — URL where the PDF document sent to the customer is located.
      - `CustomerPrice` CleverbridgeBackEndRestApiPurchaseClassesCustomerPrice — Pricing information that the customer receives during the purchase process. For descriptions of the response items, see [Additional Purchase Response Items](https://dev.cleverbridge.com/page/additional-purchase-response-items).
        - `ProductSinglePrice` object — Basic pricing information for one unit of a product.
        - `ProductTotalPrice` object — Basic pricing information for all units of a product.
        - `TotalSinglePrice` object — Complete pricing information for one unit.
        - `TotalTotalPrice` object — Complete pricing information for all units of a product.
      - `Deliveries` CleverbridgeBackEndRestApiPurchaseClassesDeliveries — Information about the delivery(s). For descriptions of the response items, see [Additional Purchase Response Items](https://dev.cleverbridge.com/page/additional-purchase-response-items).
        - `Key` object — Information about a delivery.
      - `DeliveryContact` CleverbridgeBackEndRestApiPurchaseClassesDeliveryContact — Contact's delivery information. For descriptions of the response items, see [Additional Purchase Response Items](https://dev.cleverbridge.com/page/additional-purchase-response-items).
        - `City` string — Contact's city.
        - `Company` string — Name of the company (if applicable).
        - `CompanyKatakana` string — Name of the company in Katakana (if applicable).
        - `CompanyRomanized` string — Romanized name of the company (if applicable).
        - `CompanyTypeId` 'COM' | 'GOV' | 'MIS' | 'NPR' | 'UNI' — ID of the company type. Possible values are Company = <code>COM</code>, Governmental = <code>GOV</code>, Miscellaneous = <code>MIS</code>, Non-profit = <code>NPR</code> and School/University = <code>UNI</code>.
        - `CountryId` string, required — Two-character ID of the contact's country. Submit with capital letters, for example <code>US</code>. See [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
        - `EMail` string — Contact's email address. Note: Cleverbridge has no pattern checking and does not validate email addresses.
        - `Fax` string — Contact's fax number.
        - `Firstname` string — Contact's first name.
        - `FirstnameKatakana` string — Contact's first name in Katakana.
        - `FirstnameRomanized` string — Contact's romanized first name.
        - `LanguageId` string, required — Two-character ID of the contact's language, see [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1). You must submit this with lower-case letters, for example <code>en</code>.
        - `Lastname` string — Contact's last name.
        - `LastnameKatakana` string — Contact's last name in Katakana.
        - `LastnameRomanized` string — Contact's romanized last name.
        - `Phone1` string — Contact's phone number.
        - `Phone2` string — Contact's additional phone number.
        - `PostalCode` string — Contact's postal code.
        - `SalutationId` 'MR_' | 'MS_' | 'MRS.' | 'MIS' — Contact's salutation. Possible values are Mr. = <code>MR_</code>, Ms. = <code>MS_</code>, Mrs. = <code>MRS</code>, Miss = <code>MIS</code>.
        - `StateId` string — Five- or six-character ID of the customer's country and state based on [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). It is required for Australia, Brazil, Canada, India, Ireland, Japan, the UAE, and the USA. For syntax, see [GraphQL StateEnum](https://docs.cleverbridge.com/api-documentation/graphql-api/doc/schema/stateenum.doc.html).
        - `Street1` string — Contact's street address.
        - `Street2` string — Contact's additional street information.
        - `Title` string — Contact's title.
        - `Url` string — Contact's website URL.
        - `VatId` string — Taxation number of the contact's company. It must be up-to-date, accurate, and correspond with the <code>CountryId</code>.
      - `ExtraParameters` CleverbridgeBackEndRestApiPurchaseClassesPurchaseExtraParameter[] — X-parameters used in the transaction.
        - `Key` string
        - `Value` string
      - `InternalCustomer` string — Your unique ID for a customer.
      - `Items` CleverbridgeBackEndRestApiPurchaseClassesPurchaseItems — List of purchase items. For descriptions of the response items, see [Additional Purchase Response Items](https://dev.cleverbridge.com/page/additional-purchase-response-items).
        - `Item` CleverbridgeBackEndRestApiPurchaseClassesPurchaseItem — Information about a purchase item.
          - `@RunningNo` string — Running number of the item.
          - `ProductId` string — ID of the product.
          - `ProductName` string — Product name used in customer communication.
          - `ProductNameExtension` string — Product description. Corresponds to the 'Additional name information' in the Cleverbridge platform.
          - `ProductReportingGroup` string — Type of product. For example, B2B or B2C.
          - `SupportContactId` string — Unique ID for customer support.
          - `SupportContact` string — Name of customer support.
          - `ClientId` string — The Cleverbridge ID for your company.
          - `Quantity` string — Number of items.
          - `YourCurrency` string — The currency on your account.
          - `YourCustomerId` string — Your unique ID for a customer.
          - `ProfitCalculation` CleverbridgeBackEndRestApiPurchaseClassesProfitCalculation
            - `CbMarginFix` string — Fixed amount of <code>NetRevenue</code> that Cleverbridge receives on the <code>NextBillingDate</code>.
            - `CbMarginPercentage` string — Percentage of <code>NetRevenue</code> that Cleverbridge receives on the <code>NextBillingDate</code>.
            - `CbMarketingFee` string
            - `CbShippingFee` string
            - `CollectedVat` string — Total ammount of taxes received on the <code>NextBillingDate</code>.
            - `GrossRevenue` string — Total amount of money received from customer on the <code>NextBillingDate</code>.
            - `NetRevenue` string — <code>GrossRevenue</code> subtracted by <code>NetRevenue</code> received on the <code>NextBillingDate</code>.
            - `YourGrossProfit` string — <code>YourGrossProfit</code> subtracted by <code>YourVat</code> received on the <code>NextBillingDate</code>.
            - `YourNetProfit` string — <code>NetRevenue</code> subtracted by <code>CbMarginPercentage</code> and <code>CbMarginFix</code> received on the <code>NextBillingDate</code>.
            - `YourVat` string — Taxes that you must pay on the <code>NextBillingDate</code>.
      - `LastModificationTime` string — Date and time when the last change was made according to [RFC3339](https://www.rfc-editor.org/info/rfc3339).
      - `LicenseeContact` CleverbridgeBackEndRestApiPurchaseClassesLicenseeContact — Contact's licensee information. For descriptions of the response items, see [Additional Purchase Response Items](https://dev.cleverbridge.com/page/additional-purchase-response-items).
        - `City` string — Contact's city.
        - `Company` string — Name of the company (if applicable).
        - `CompanyKatakana` string — Name of the company in Katakana (if applicable).
        - `CompanyRomanized` string — Romanized name of the company (if applicable).
        - `CompanyTypeId` 'COM' | 'GOV' | 'MIS' | 'NPR' | 'UNI' — ID of the company type. Possible values are Company = <code>COM</code>, Governmental = <code>GOV</code>, Miscellaneous = <code>MIS</code>, Non-profit = <code>NPR</code> and School/University = <code>UNI</code>.
        - `CountryId` string, required — Two-character ID of the contact's country. Submit with capital letters, for example <code>US</code>. See [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
        - `EMail` string — Contact's email address. Note: Cleverbridge has no pattern checking and does not validate email addresses.
        - `Fax` string — Contact's fax number.
        - `Firstname` string — Contact's first name.
        - `FirstnameKatakana` string — Contact's first name in Katakana.
        - `FirstnameRomanized` string — Contact's romanized first name.
        - `LanguageId` string, required — Two-character ID of the contact's language, see [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1). You must submit this with lower-case letters, for example <code>en</code>.
        - `Lastname` string — Contact's last name.
        - `LastnameKatakana` string — Contact's last name in Katakana.
        - `LastnameRomanized` string — Contact's romanized last name.
        - `Phone1` string — Contact's phone number.
        - `Phone2` string — Contact's additional phone number.
        - `PostalCode` string — Contact's postal code.
        - `SalutationId` 'MR_' | 'MS_' | 'MRS.' | 'MIS' — Contact's salutation. Possible values are Mr. = <code>MR_</code>, Ms. = <code>MS_</code>, Mrs. = <code>MRS</code>, Miss = <code>MIS</code>.
        - `StateId` string — Five- or six-character ID of the customer's country and state based on [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). It is required for Australia, Brazil, Canada, India, Ireland, Japan, the UAE, and the USA. For syntax, see [GraphQL StateEnum](https://docs.cleverbridge.com/api-documentation/graphql-api/doc/schema/stateenum.doc.html).
        - `Street1` string — Contact's street address.
        - `Street2` string — Contact's additional street information.
        - `Title` string — Contact's title.
        - `Url` string — Contact's website URL.
        - `VatId` string — Taxation number of the contact's company. It must be up-to-date, accurate, and correspond with the <code>CountryId</code>.
      - `MerchantOfRecord` string — Whether Cleverbridge acts as merchant of record or as service provider. Possible values as merchant of record are either <code>AG</code> or <code>Inc.</code>.
      - `NotificationDate` string — Date when <code>PaidOrderNotification</code> was sent according to [RFC3339](https://www.rfc-editor.org/info/rfc3339).
      - `PaymentArriveTime` string — Date and time when payment was processed according to [RFC3339](https://www.rfc-editor.org/info/rfc3339).
      - `PaymentInfo` CleverbridgeBackEndRestApiSubscriptionClassesPaymentInfoModel — Information about the payments. For descriptions of the response items, see [Additional Purchase Response Items](https://dev.cleverbridge.com/page/additional-purchase-response-items).
        - `CardExpirationDate` CleverbridgeBackEndRestApiSubscriptionClassesCardExpirationDateModel — Expiration date of the card. For descriptions of the response items, see [Additional Subscription Response Items](https://dev.cleverbridge.com/page/additional-subscription-response-items).
          - `Month` integer — Expiration month.
          - `Year` integer — Expiration year.
        - `CardLastFourDigits` string — Last four digits of the card number.
        - `Currency` string — The currency of the defined price.
        - `CurrencyId` string — Currency code in capital letters, see [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
        - `IsPurchaseOrder` string — Whether or not a purchase order was used.
        - `PaymentType` string — Payment method used. For a list of values, see [Payment Type](https://dev.cleverbridge.com/reference/payment-type).
        - `PaymentTypeId` string — ID of the payment method. For a list of values, see [Payment Type](https://dev.cleverbridge.com/reference/payment-type).
      - `Purchase` CleverbridgeBackEndRestApiPurchaseClassesPurchase — All information about the purchase. For descriptions of the response items, see [Additional Purchase Response Items](https://dev.cleverbridge.com/page/additional-purchase-response-items).
        - `@Id` string — Unique ID of the purchase.
        - `Status` string — Current purchase status.
        - `StatusId` string — Current purchase status notification ID. For more information, see [Purchase Status](https://dev.cleverbridge.com/reference/purchase-status).
      - `RecurringBilling` CleverbridgeBackEndRestApiPurchaseClassesRecurringBilling — Information about the subscription (if applicable). For descriptions of the response items, see [Additional Purchase Response Items](https://dev.cleverbridge.com/page/additional-purchase-response-items).
        - `@SubscriptionId` string — Unique ID of the subscription.
        - `@SubscriptionItemRunningNo` string — Running number of the item in the subscription.
        - `CancellationUrl` string — URL where the customer can find the subscription cancellation page.
        - `ChangePaymentSubscriptionUrl` string — URL where the customer can find the change payment method page.
        - `GracePeriodDays` string — The number of days in which the customer can use the product during a grace period.
        - `IntervalNo` string — Number of the last successfully paid interval of the subscription. Counting starts at 0. For each successfully paid interval, the number is increased by one.
        - `ItemStatus` string — Status of the subscription item. For more information, see [Subscription Statuses](https://docs.cleverbridge.com/public/all/using-the-platform/subscription-statuses-and-update-options.htm#Statuses?utm_source=developer-docs&amp;utm_medium=api-reference).
        - `ItemStatusId` string — ID that correspondes to the <code>Item Status</code>.
        - `NextBillingDate` string — Next billing date according to [RFC3339](https://www.rfc-editor.org/info/rfc3339). Specified in UTC.
        - `NextBillingProfit` object — Financial figures related to the <code>NextBillingDate</code>.
        - `OriginalPurchaseId` string — Unique ID of the purchase.
        - `OriginalPurchaseItemRunningNo` string — Running number of the item in the purchase.
        - `Status` string — Status of the subscription. For more information, see [Subscription Statuses](https://docs.cleverbridge.com/public/all/using-the-platform/subscription-statuses-and-update-options.htm#Statuses?utm_source=developer-docs&amp;utm_medium=api-reference).
        - `StatusId` string — ID that correspondes to the <code>Status</code>.
      - `SubscriptionRevenueCategoryId` string — Type of subscription. For example, <code>AutoRenewal</code> or <code>ManualRenewal</code>.
      - `YourPrice` CleverbridgeBackEndRestApiPurchaseClassesYourPrice — Pricing information that your company set up in the Cleverbridge platform. For descriptions of the response items, see [Additional Purchase Response Items](https://dev.cleverbridge.com/page/additional-purchase-response-items).
        - `ProductSinglePrice` object — Basic pricing information for one unit of a product.
        - `ProductTotalPrice` object — Basic pricing information for all units of a product.
        - `TotalSinglePrice` object — Complete pricing information for one unit.
        - `TotalTotalPrice` object — Complete pricing information for all units of a product.
  - `ResultMessage` string — Optional result or error message.

## Other responses

- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/cleverbridge/apis/backend-rest-apis.md) · [All operations](https://skmtc.net/cleverbridge/apis/backend-rest-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cleverbridge/backend-rest-apis/versions/b7007b62f4c0/schema)