Sign in

v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB
Accounts

Retrieve an account

Returns the details of an account with the given account_id.

get/accounts/{account_id}

Path parameters

account_idstring required
Example:abcDEFgHiJklM1N-3OP9q

Unique identifier for the account.

Response

OK

idstring

The unique account identifier.

accountstring

The unique account identifier.

actionstring

The action performed by the API call.

languagestring

Two-letter language code (<a href="https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes">ISO 639</a>).

countrystring

Two-letter country code (<a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-1 alpha-2</a>).

urlstring

FastSpring account URL.

subscribedboolean

A boolean indicating whether an account includes a subscription or not.

resultstring

Indicates that the request has succeeded or failed.

taxExemptionDatastring

Tax exemption details.

Example response

{
  "id": "abcDEFgHiJklM1N-3OP9q",
  "account": "abcDEFgHiJklM1N-3OP9q",
  "action": "account.get",
  "contact": {
    "first": "First",
    "last": "Last",
    "email": "first.last@domain.com",
    "company": "Company Name",
    "phone": "555-555-5555",
    "subscribed": true
  },
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Apt. 456",
    "city": "Santa Barbara",
    "region": "US-CA",
    "regionCustom": "555-555-5555",
    "company": "Company Name"
  },
  "language": "en",
  "country": "US",
  "lookup": {
    "global": "ab-Cd9e8F6ghiJ-Okl3M3n",
    "custom": "customKey"
  },
  "url": "https://user.test.onfastspring.com/account",
  "payment": {
    "methods": 1,
    "active": 1
  },
  "orders": [
    "aAB0cdefGHiJkL0m8n8OpQ",
    "rST2uv1wXy279zABCd_E2f"
  ],
  "subscriptions": [
    "84a1bCDEf86g_-HijK_LMN"
  ],
  "charges": [
    {
      "currency": "USD",
      "payoutCurrency": "USD",
      "totalInPayoutCurrency": 100,
      "status": "successful",
      "order": "aAB0cdefGHiJkL0m8n8OpQ",
      "orderReference": "ABC230906-7581-30108",
      "subscription": "84a1bCDEf86g_-HijK_LMN",
      "timestamp": 1693959029538,
      "timestampValue": 1693959029538,
      "timestampInSeconds": 1693959029
    }
  ],
  "subscribed": true,
  "result": "success"
}