Account

Deprecated

Create or Update an account

post

Use this method to update impact.com when the status of an account changes or when a new account is created. This call is only available on a classic program.

Authorizations

APIKey

AuthorizationstringRequired

Path parameters

tenant_aliasstringRequired

Tenant being referenced.

Body

application/json

idstringRequired

Unique identifier for the account.

Example: abc123

currencystringOptional

ISO 4217 standard currency code (e.g. USD, EUR).

Example: USD

Responses

200

Account created or updated.

application/json

idstringRequired

Unique identifier for the account.

Example: abc123

currencystringOptional

ISO 4217 standard currency code (e.g. USD, EUR).

Example: USD

403

Endpoint is deprecated and not available on non-classic programs.

application/json

post/{tenant_alias}/accountsync

cURL

curl -L \
  --request POST \
  --url 'https://app.referralsaasquatch.com/api/v1/{tenant_alias}/accountsync' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Content-Type: application/json' \
  --header 'Accept: */*'

{
  "id": "abc123",
  "subscription": {
    "status": "PAID",
    "billingIntervalType": "MONTH",
    "billingIntervalValue": 1,
    "value": 49.99
  },
  "referral": {
    "code": "BOBTESTERSON"
  },
  "currency": "USD"
}

Deprecated

Lookup an account

get

Looks up an Account based upon id and returns the stored account information. This call is only available on a classic program.

Authorizations

APIKey

AuthorizationstringRequired

Path parameters

tenant_aliasstringRequired

Tenant being referenced. E.g. "aboih12h16t" or "test_abo912126tastastt"

accountIdstringRequired

The id of the account to look up.

Responses

200

Account found.

application/json

idstringRequired

Unique identifier for the account.

Example: abc123

currencystringOptional

ISO 4217 standard currency code (e.g. USD, EUR).

Example: USD

403

Endpoint is deprecated and not available on non-classic programs.

application/json

404

Account NOT found.

application/json

get/{tenant_alias}/account/{accountId}

cURL

curl -L \
  --url 'https://app.referralsaasquatch.com/api/v1/{tenant_alias}/account/{accountId}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

{
  "id": "abc123",
  "subscription": {
    "status": "PAID",
    "billingIntervalType": "MONTH",
    "billingIntervalValue": 1,
    "value": 49.99
  },
  "referral": {
    "code": "BOBTESTERSON"
  },
  "currency": "USD"
}