The account this key acts for

GET

/account

curl --request GET \
  --url https://api.creatorain.com/v1/account \
  --header 'Authorization: Bearer <token>'

• Live (crp_live_ keys)
• Sandbox (crp_test_ keys)

Scope read. blockers is empty and next_action is null until the issues that own each account state ship. counting_locations counts the live stores of this workspace only.

Authorizations

• bearerAuth

Responses

200

The account.

Media typeapplication/json

object

id

required

string

name

required

string

livemode

required

boolean

status

required

string

Allowed values: awaiting_payment active past_due paused stopped

counting_locations

required

integer

min_locations

required

integer

max_locations

required

integer

blockers

required

Array<string>

next_action

required

object

created_at

required

string format: date-time

Example

{
  "id": "acct_3f2a9c1e5b7d4a6f8e0c2b4d6f8a0c2e",
  "status": "awaiting_payment",
  "min_locations": 3,
  "max_locations": 50
}

Headers

Request-Id

string format: uuid

This request’s id. Equal to error.request_id; quote it to support.

RateLimit-Limit

integer

Example

600

Requests allowed in the current minute for this workspace (600).

RateLimit-Remaining

integer

Requests left in the current minute for this workspace.

RateLimit-Reset

integer

Seconds until the current window resets.

401

Invalid_key, test_key_on_live or live_key_on_sandbox.

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error idempotency_error rate_limit_error api_error

code

required

string

Allowed values: parameter_invalid invalid_json idempotency_key_invalid idempotency_key_required customization_not_supported videos_per_month_out_of_range batch_invalid terms_not_accepted invalid_key test_key_on_live live_key_on_sandbox insufficient_balance scope_missing forbidden_ip forbidden live_key_requires_top_up limit_raise_requires_dashboard not_found idempotency_conflict idempotency_in_progress conflict location_already_in_network external_id_conflict dispute_open request_too_large address_not_verified not_food_business metro_not_served package_not_available account_location_limit commit_limit_exceeded top_up_exceeds_feasible no_saved_card rate_limited quota_exceeded slow_down internal_error service_unavailable

message

required

string

field

The request field at fault

string

doc_url

required

string format: uri

request_id

required

string format: uuid

items

Batch_invalid only. Every refused location, by its index in the request.

Array<object>

object

index

required

integer

code

required

One of the error codes above.

string

field

string

message

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid",
    "doc_url": "https://www.creatorain.com/api/errors#scope_missing",
    "items": [
      {
        "field": "locations.1.videos_per_month"
      }
    ]
  }
}

Headers

Request-Id

string format: uuid

This request’s id. Equal to error.request_id; quote it to support.

403

Scope_missing or forbidden_ip.

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error idempotency_error rate_limit_error api_error

code

required

string

Allowed values: parameter_invalid invalid_json idempotency_key_invalid idempotency_key_required customization_not_supported videos_per_month_out_of_range batch_invalid terms_not_accepted invalid_key test_key_on_live live_key_on_sandbox insufficient_balance scope_missing forbidden_ip forbidden live_key_requires_top_up limit_raise_requires_dashboard not_found idempotency_conflict idempotency_in_progress conflict location_already_in_network external_id_conflict dispute_open request_too_large address_not_verified not_food_business metro_not_served package_not_available account_location_limit commit_limit_exceeded top_up_exceeds_feasible no_saved_card rate_limited quota_exceeded slow_down internal_error service_unavailable

message

required

string

field

The request field at fault

string

doc_url

required

string format: uri

request_id

required

string format: uuid

items

Batch_invalid only. Every refused location, by its index in the request.

Array<object>

object

index

required

integer

code

required

One of the error codes above.

string

field

string

message

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid",
    "doc_url": "https://www.creatorain.com/api/errors#scope_missing",
    "items": [
      {
        "field": "locations.1.videos_per_month"
      }
    ]
  }
}

Headers

Request-Id

string format: uuid

This request’s id. Equal to error.request_id; quote it to support.

404

Not_found.

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error idempotency_error rate_limit_error api_error

code

required

string

Allowed values: parameter_invalid invalid_json idempotency_key_invalid idempotency_key_required customization_not_supported videos_per_month_out_of_range batch_invalid terms_not_accepted invalid_key test_key_on_live live_key_on_sandbox insufficient_balance scope_missing forbidden_ip forbidden live_key_requires_top_up limit_raise_requires_dashboard not_found idempotency_conflict idempotency_in_progress conflict location_already_in_network external_id_conflict dispute_open request_too_large address_not_verified not_food_business metro_not_served package_not_available account_location_limit commit_limit_exceeded top_up_exceeds_feasible no_saved_card rate_limited quota_exceeded slow_down internal_error service_unavailable

message

required

string

field

The request field at fault

string

doc_url

required

string format: uri

request_id

required

string format: uuid

items

Batch_invalid only. Every refused location, by its index in the request.

Array<object>

object

index

required

integer

code

required

One of the error codes above.

string

field

string

message

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid",
    "doc_url": "https://www.creatorain.com/api/errors#scope_missing",
    "items": [
      {
        "field": "locations.1.videos_per_month"
      }
    ]
  }
}

Headers

Request-Id

string format: uuid

This request’s id. Equal to error.request_id; quote it to support.

429

Rate_limited (600 a minute per workspace, an onboarding create limit, or an address blocked after failed authentication), or slow_down (an onboarding session polled too fast).

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error idempotency_error rate_limit_error api_error

code

required

string

Allowed values: parameter_invalid invalid_json idempotency_key_invalid idempotency_key_required customization_not_supported videos_per_month_out_of_range batch_invalid terms_not_accepted invalid_key test_key_on_live live_key_on_sandbox insufficient_balance scope_missing forbidden_ip forbidden live_key_requires_top_up limit_raise_requires_dashboard not_found idempotency_conflict idempotency_in_progress conflict location_already_in_network external_id_conflict dispute_open request_too_large address_not_verified not_food_business metro_not_served package_not_available account_location_limit commit_limit_exceeded top_up_exceeds_feasible no_saved_card rate_limited quota_exceeded slow_down internal_error service_unavailable

message

required

string

field

The request field at fault

string

doc_url

required

string format: uri

request_id

required

string format: uuid

items

Batch_invalid only. Every refused location, by its index in the request.

Array<object>

object

index

required

integer

code

required

One of the error codes above.

string

field

string

message

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid",
    "doc_url": "https://www.creatorain.com/api/errors#scope_missing",
    "items": [
      {
        "field": "locations.1.videos_per_month"
      }
    ]
  }
}

Headers

Request-Id

string format: uuid

This request’s id. Equal to error.request_id; quote it to support.

Retry-After

integer

>= 1

Seconds to wait before retrying (at least 1).

500

Internal_error (500) or service_unavailable (503). The message never carries a cause.

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error idempotency_error rate_limit_error api_error

code

required

string

Allowed values: parameter_invalid invalid_json idempotency_key_invalid idempotency_key_required customization_not_supported videos_per_month_out_of_range batch_invalid terms_not_accepted invalid_key test_key_on_live live_key_on_sandbox insufficient_balance scope_missing forbidden_ip forbidden live_key_requires_top_up limit_raise_requires_dashboard not_found idempotency_conflict idempotency_in_progress conflict location_already_in_network external_id_conflict dispute_open request_too_large address_not_verified not_food_business metro_not_served package_not_available account_location_limit commit_limit_exceeded top_up_exceeds_feasible no_saved_card rate_limited quota_exceeded slow_down internal_error service_unavailable

message

required

string

field

The request field at fault

string

doc_url

required

string format: uri

request_id

required

string format: uuid

items

Batch_invalid only. Every refused location, by its index in the request.

Array<object>

object

index

required

integer

code

required

One of the error codes above.

string

field

string

message

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid",
    "doc_url": "https://www.creatorain.com/api/errors#scope_missing",
    "items": [
      {
        "field": "locations.1.videos_per_month"
      }
    ]
  }
}

Headers

Request-Id

string format: uuid

This request’s id. Equal to error.request_id; quote it to support.

503

Internal_error (500) or service_unavailable (503). The message never carries a cause.

Media typeapplication/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error idempotency_error rate_limit_error api_error

code

required

string

Allowed values: parameter_invalid invalid_json idempotency_key_invalid idempotency_key_required customization_not_supported videos_per_month_out_of_range batch_invalid terms_not_accepted invalid_key test_key_on_live live_key_on_sandbox insufficient_balance scope_missing forbidden_ip forbidden live_key_requires_top_up limit_raise_requires_dashboard not_found idempotency_conflict idempotency_in_progress conflict location_already_in_network external_id_conflict dispute_open request_too_large address_not_verified not_food_business metro_not_served package_not_available account_location_limit commit_limit_exceeded top_up_exceeds_feasible no_saved_card rate_limited quota_exceeded slow_down internal_error service_unavailable

message

required

string

field

The request field at fault

string

doc_url

required

string format: uri

request_id

required

string format: uuid

items

Batch_invalid only. Every refused location, by its index in the request.

Array<object>

object

index

required

integer

code

required

One of the error codes above.

string

field

string

message

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid",
    "doc_url": "https://www.creatorain.com/api/errors#scope_missing",
    "items": [
      {
        "field": "locations.1.videos_per_month"
      }
    ]
  }
}

Headers

Request-Id

string format: uuid

This request’s id. Equal to error.request_id; quote it to support.