Create Account

POST

accounts

{
  "name": "GoJo",
  "aliases": ["JoGo"],
  "currency": "USD",
  "billingAddress": {
    "line1": "123 Main St",
    "line2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001"
  },
  "contacts": [
    {
      "email": "sales@gojo.com",
      "firstName": "Henry",
      "lastName": "Sules",
      "isPrimary": true,
      "emailPreferences": ["updates"]
    },
    {
      "email": "finance@gojo.com",
      "firstName": "Accounts",
      "lastName": "Receivable",
      "isPrimary": false,
      "emailPreferences": ["billing"]
    }
  ]
}

{
  "id": "ywgWhtGp",
  "name": "GoJo",
  "aliases": ["JoGo"],
  "currency": "USD",
  "billingAddress": {
    "line1": "123 Main St",
    "line2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001"
  },
  "contacts": [
    {
      "id": "OLgPyqFF",
      "email": "sales@gojo.com",
      "firstName": "Henry",
      "lastName": "Sules",
      "isPrimary": true,
      "emailPreferences": ["updates"]
    },
    {
      "id": "FdqPzqFG",
      "email": "finance@gojo.com",
      "firstName": "Accounts",
      "lastName": "Receivable",
      "isPrimary": false,
      "emailPreferences": ["billing"]
    }
  ],
  "createdAt": "2023-09-05T21:54:54.609688Z",
  "updatedAt": "2023-09-05T21:54:54.609689Z"
}

{
  "name": "GoJo",
  "aliases": ["JoGo"],
  "currency": "USD",
  "billingAddress": {
    "line1": "123 Main St",
    "line2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001"
  },
  "contacts": [
    {
      "email": "sales@gojo.com",
      "firstName": "Henry",
      "lastName": "Sules",
      "isPrimary": true,
      "emailPreferences": ["updates"]
    },
    {
      "email": "finance@gojo.com",
      "firstName": "Accounts",
      "lastName": "Receivable",
      "isPrimary": false,
      "emailPreferences": ["billing"]
    }
  ]
}

Request

string

required

The name of the account.

[]string

The list of alternative or external IDs for the account. These can be used to identify the account in place of the Alguna id.

[]Contact

The contacts associated with the account.

Show properties

string

The email address of the contact.

string

The first name of the contact.

string

The last name of the contact.

string

Whether the contact is the primary contact for the account.

[]string

The email preferences for the contact. Valid values are updates and billing.

Address

The billing address for the account.

Show properties

string

required

The first line of the address.

string

The second line of the address.

string

required

The city of the address.

string

required

The state of the address.

string

required

The postal code / zip code of the address.

string

required

The country of the address. This must be a valid ISO 3166-1 alpha-2 country code.

string

required

The currency in which the account will be billed. This must be a valid ISO 4217 currency code.

Response

{
  "id": "ywgWhtGp",
  "name": "GoJo",
  "aliases": ["JoGo"],
  "currency": "USD",
  "billingAddress": {
    "line1": "123 Main St",
    "line2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001"
  },
  "contacts": [
    {
      "id": "OLgPyqFF",
      "email": "sales@gojo.com",
      "firstName": "Henry",
      "lastName": "Sules",
      "isPrimary": true,
      "emailPreferences": ["updates"]
    },
    {
      "id": "FdqPzqFG",
      "email": "finance@gojo.com",
      "firstName": "Accounts",
      "lastName": "Receivable",
      "isPrimary": false,
      "emailPreferences": ["billing"]
    }
  ],
  "createdAt": "2023-09-05T21:54:54.609688Z",
  "updatedAt": "2023-09-05T21:54:54.609689Z"
}

string

The Alguna ID of the account.

string

The name of the account.

[]string

The list of alternative or external IDs for the account. These can be used to identify the account in place of the Alguna id.

[]Contact

The contacts associated with the account.

Show properties

string

The Alguna ID of the contact.

string

The email address of the contact.

string

The first name of the contact.

string

The last name of the contact.

string

Whether the contact is the primary contact for the account.

[]string

The email preferences for the contact. Valid values are updates and billing.

Address

The billing address for the account.

Show properties

string

The first line of the address.

string

The second line of the address.

string

The city of the address.

string

The state of the address.

string

The postal code / zip code of the address.

string

The country of the address.

string

The ISO 4217 currency in which the account is billed.

datetime

The date and time at which the account was created.

datetime

The date and time at which the account was last updated.

Get Customer

⌘I

{
  "name": "GoJo",
  "aliases": ["JoGo"],
  "currency": "USD",
  "billingAddress": {
    "line1": "123 Main St",
    "line2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001"
  },
  "contacts": [
    {
      "email": "sales@gojo.com",
      "firstName": "Henry",
      "lastName": "Sules",
      "isPrimary": true,
      "emailPreferences": ["updates"]
    },
    {
      "email": "finance@gojo.com",
      "firstName": "Accounts",
      "lastName": "Receivable",
      "isPrimary": false,
      "emailPreferences": ["billing"]
    }
  ]
}

{
  "id": "ywgWhtGp",
  "name": "GoJo",
  "aliases": ["JoGo"],
  "currency": "USD",
  "billingAddress": {
    "line1": "123 Main St",
    "line2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001"
  },
  "contacts": [
    {
      "id": "OLgPyqFF",
      "email": "sales@gojo.com",
      "firstName": "Henry",
      "lastName": "Sules",
      "isPrimary": true,
      "emailPreferences": ["updates"]
    },
    {
      "id": "FdqPzqFG",
      "email": "finance@gojo.com",
      "firstName": "Accounts",
      "lastName": "Receivable",
      "isPrimary": false,
      "emailPreferences": ["billing"]
    }
  ],
  "createdAt": "2023-09-05T21:54:54.609688Z",
  "updatedAt": "2023-09-05T21:54:54.609689Z"
}

API Reference

Billing Events & Usage Metering

Bundles

Credit Grants

Credit Notes

Customers

Invoices

Plans

Products

Refunds

Subscriptions

Subscription Versions

Wallets

Request

Response

​Request

​Response

Request

Response