# Get a credit purchase

> GET /v1/account/purchases/{id}. One purchase of credits by card.

Source: https://emailmovers.com/mydatahub/docs/reference/rest/get-credit-purchase

`GET /v1/account/purchases/{id}`

One purchase of credits by card. Reading a pending purchase asks Stripe for its checkout and, once the payment is paid, adds the credits exactly once and writes the payment receipt, so the page Checkout returns to can show the credits added. Until then it stays pending. 503 when card payments are switched off and the purchase is still pending.

| Property | Value |
| --- | --- |
| Endpoint | `GET https://mydatahub.emailmovers.com/v1/account/purchases/{id}` |
| Operation id | `getCreditPurchase` |
| Cost | Free (0 credits) |
| Access | An API key or an OAuth 2.1 token with the scope `account:read`. |
| Tag | Account |

> **Not yet live.** MyDataHub v2 is built and tested locally and is not yet live. The v2 hosts open at launch, date to confirm. This page describes the contract the API is tested against.

## Request

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string | yes | Format: a credit purchase id: pur_ followed by a 26 character ULID in upper case Crockford base32, such as pur_01JB4R7K2V7XN3M9R6T1Y5W8ZA. |
| `MyDataHub-Version` | header | string | no | The dated API version, pinned per key when left out. Non-breaking changes ship as new dates; the path major changes only for breaking changes, with a 12 month deprecation window. |

## Example request

```bash
curl "https://mydatahub.emailmovers.com/v1/account/purchases/pur_01JB4R7K2V7XN3M9R6T1Y5W8ZA" \
  -H "Authorization: Bearer $MYDATAHUB_API_KEY"
```

## Responses

### 200: The purchase.

Headers: `RateLimit`, `RateLimit-Policy`.

| Member | Type | Always present | Description |
| --- | --- | --- | --- |
| `id` | string | yes | Format: a credit purchase id: pur_ followed by a 26 character ULID in upper case Crockford base32, such as pur_01JB4R7K2V7XN3M9R6T1Y5W8ZA. |
| `status` | enum: `pending`, `paid`, `expired` | yes | pending until Stripe says the payment is paid; paid once the credits are in the balance; expired when the checkout closed unpaid (nothing was taken). |
| `label` | string | yes | What is bought, in words, numbers first. |
| `lines` | array of `CreditPurchaseLine` | yes |  |
| `lines[].id` | string | yes | per_contact_scale or a credit pack id. |
| `lines[].quantity` | integer (0 or more) | yes | Credits at the scale, or credit packs. |
| `lines[].credits` | integer (0 or more) | yes |  |
| `lines[].gbp_ex_vat` | number (0 or more) | yes | Pounds sterling excluding VAT, to two decimal places. |
| `credits` | integer (0 or more) | yes | Credits the purchase adds when paid. |
| `gbp_ex_vat` | number (0 or more) | yes | Pounds sterling excluding VAT, to two decimal places. |
| `vat_rate_percent` | number (0 to 100) | yes |  |
| `vat_gbp` | number (0 or more) | yes | Pounds sterling, to two decimal places. |
| `total_gbp` | number (0 or more) | yes | What the card is charged, VAT included. |
| `currency` | `GBP` | yes |  |
| `gbp_per_credit` | number (0 or more) | yes | What one credit of this purchase cost, excluding VAT, to six decimal places. Orders value the credits they spend at it. |
| `credits_added` | integer (0 or more) | yes | 0 until the payment is paid. |
| `checkout_url` | string (uri) or null | yes | Stripe Checkout, while the purchase is pending; null once paid or expired. |
| `test_mode` | boolean | yes | Made with a Stripe test key: test cards only, and no money moves. |
| `created_at` | string (date-time) | yes |  |
| `expires_at` | string (date-time) or null | yes | When the checkout closes if it is not paid. |
| `paid_at` | string (date-time) or null | yes |  |
| `attention` | `PurchaseAttention` or null | yes |  |
| `attention.reason` | enum: `checkout_mismatch`, `billed_outside_uk` | yes | checkout_mismatch: Stripe says it is paid but the checkout does not match this purchase, so no credits were added; billed_outside_uk: credited, but the billing address is not in the UK. |
| `attention.detail` | string | yes | What a person should look at, in plain English. |
| `attention.since` | string (date-time) | yes |  |
| `receipt` | `PaymentReceipt` or null | yes | Once paid. The buyer's name, billing address and VAT number are shown only to a signed-in person with admin; anyone else sees them as null. |
| `receipt.number` | string | yes | The receipt number, such as MDH-000042: one sequence for every receipt, with no number skipped. |
| `receipt.issued_at` | string (date-time) | yes |  |
| `receipt.supplier` | object | yes | Who sold the credits, as the server's settings name them when the receipt is written. In production a receipt is never written without them; a development server may leave them null. |
| `receipt.customer` | object | yes | Who bought the credits, as Stripe Checkout collected it. |
| `receipt.description` | string | yes | What was bought, such as 1 credit pack of 40,000. |
| `receipt.credits` | integer (0 or more) | yes |  |
| `receipt.gbp_per_credit` | number (0 or more) | yes | The unit price: one credit, excluding VAT, to six decimal places. |
| `receipt.gbp_ex_vat` | number (0 or more) | yes | Pounds sterling excluding VAT, to two decimal places. |
| `receipt.vat_rate_percent` | number (0 to 100) | yes |  |
| `receipt.vat_gbp` | number (0 or more) | yes | Pounds sterling, to two decimal places. |
| `receipt.total_gbp` | number (0 or more) | yes | What the card was charged, VAT included. |
| `receipt.paid_by` | `card` | yes | Card, through Stripe Checkout. |
| `receipt.payment_reference` | string | yes | Stripe's reference for the payment. |
| `receipt.refunds` | string | yes | The refund terms the purchase was made under. |
| `receipt.test_mode` | boolean | yes | A Stripe test mode payment: no money moved. |

#### Example response

```json
{
  "id": "pur_01JB4R7K2V7XN3M9R6T1Y5W8ZA",
  "label": "1 credit pack of 40,000",
  "lines": [
    {
      "id": "credit_pack_40000",
      "quantity": 1,
      "credits": 40000,
      "gbp_ex_vat": 1249
    }
  ],
  "credits": 40000,
  "gbp_ex_vat": 1249,
  "vat_rate_percent": 20,
  "vat_gbp": 249.8,
  "total_gbp": 1498.8,
  "currency": "GBP",
  "gbp_per_credit": 0.031225,
  "test_mode": true,
  "created_at": "2026-10-16T10:00:00Z",
  "expires_at": "2026-10-17T10:00:00Z",
  "attention": null,
  "status": "paid",
  "credits_added": 40000,
  "checkout_url": null,
  "paid_at": "2026-10-16T10:03:12Z",
  "receipt": {
    "number": "MDH-000042",
    "issued_at": "2026-10-16T10:03:12Z",
    "supplier": {
      "name": "Example Supplier Limited",
      "company_number": "00000000",
      "registered_office": "1 Example Street, Exampletown, EX1 1EX, England",
      "vat_number": "GB000000000"
    },
    "customer": {
      "organisation_id": "org_01JA0Q2V7XN3M9R6T1Y5W8ZAK8",
      "organisation_name": "Example Agency Ltd",
      "business_name": "Example Agency Ltd",
      "name": "Example Agency Ltd",
      "address": {
        "line1": "2 Sample Road",
        "line2": null,
        "city": "Exampletown",
        "postal_code": "EX2 2EX",
        "state": null,
        "country": "GB"
      },
      "vat_number": "GB999999999"
    },
    "description": "1 credit pack of 40,000",
    "credits": 40000,
    "gbp_per_credit": 0.031225,
    "gbp_ex_vat": 1249,
    "vat_rate_percent": 20,
    "vat_gbp": 249.8,
    "total_gbp": 1498.8,
    "paid_by": "card",
    "payment_reference": "pi_test_EXAMPLE",
    "refunds": "Credits and credit packs are not refundable once bought, except where the law requires.",
    "test_mode": true
  }
}
```

## Errors

Every error is a problem object with a `code` and a `next_step`. Every response carries the `RateLimit` and `RateLimit-Policy` headers; see [Rate limits](https://emailmovers.com/mydatahub/docs/rate-limits.md).

| Status | Problem codes | When |
| --- | --- | --- |
| 400 | [`invalid-request`](https://emailmovers.com/mydatahub/docs/errors/invalid-request.md), [`idempotency-key-required`](https://emailmovers.com/mydatahub/docs/errors/idempotency-key-required.md), [`unsupported-version`](https://emailmovers.com/mydatahub/docs/errors/unsupported-version.md) | The request could not be read, or an Idempotency-Key is missing. |
| 401 | [`authentication-required`](https://emailmovers.com/mydatahub/docs/errors/authentication-required.md), [`account-required`](https://emailmovers.com/mydatahub/docs/errors/account-required.md) | Sign in (OAuth) or send an API key (authentication-required), or create a free account for what the anonymous tier does not cover (account-required). |
| 403 | [`insufficient-scope`](https://emailmovers.com/mydatahub/docs/errors/insufficient-scope.md), [`confirmation-required`](https://emailmovers.com/mydatahub/docs/errors/confirmation-required.md), [`business-details-required`](https://emailmovers.com/mydatahub/docs/errors/business-details-required.md), [`licence-acceptance-required`](https://emailmovers.com/mydatahub/docs/errors/licence-acceptance-required.md), [`dpa-acceptance-required`](https://emailmovers.com/mydatahub/docs/errors/dpa-acceptance-required.md), [`agent-budget-exceeded`](https://emailmovers.com/mydatahub/docs/errors/agent-budget-exceeded.md) | The token lacks a scope (insufficient-scope, with required_scope and a WWW-Authenticate step-up challenge); no person confirmed the spend and no agent key covers it (confirmation-required, with an approval_url); an agent key's per-order cap or monthly budget does not cover it (agent-budget-exceeded); an account made by self-serve sign-up has not yet confirmed its business name and that it is a UK business, which its first order needs (business-details-required); the order needs the Data Licence and Sharing Agreement accepted at the version in force (licence-acceptance-required); or a suppression upload comes before the organisation has accepted the Article 28 data processing agreement in force (dpa-acceptance-required). Nothing is charged. |
| 404 | [`not-found`](https://emailmovers.com/mydatahub/docs/errors/not-found.md) | No such object for this organisation. |
| 429 | [`rate-limited`](https://emailmovers.com/mydatahub/docs/errors/rate-limited.md) | Too many requests. Wait for Retry-After. |
| Any other failure | [`internal-error`](https://emailmovers.com/mydatahub/docs/errors/internal-error.md), [`service-unavailable`](https://emailmovers.com/mydatahub/docs/errors/service-unavailable.md), [`tps-screen-expired`](https://emailmovers.com/mydatahub/docs/errors/tps-screen-expired.md) | Something failed on our side (500 internal-error) or the service is briefly unavailable (503 service-unavailable, with Retry-After). Nothing was charged; retry with the same Idempotency-Key. A count, sample, quote or order with telephone in play is also refused with 503 tps-screen-expired, with no Retry-After, while the dataset version's TPS and CTPS screen is more than 28 days old. |
