Skip to content
Sections

API reference

Accounts

For partners: switch tenants on and off, issue their credentials and send them to billing.

Create an account for a tenant

post/v1/accounts

Partner only. Creates the account as pending_payment and returns a Stripe Checkout link. Calling again for the same external_ref returns the same account (201 the first time, 200 after), with a fresh link while it is unpaid. The account becomes active when Stripe confirms payment, and account.activated is sent to the partner. With free_access: true (partners Presslane Suppliers set up for it) the account is active at once on the partner’s free plan, with no Checkout and no charge; sent for an existing tenant it gives that tenant free access (a subscription it pays is paused).

Called by
Partner client
Scope
accounts:write

Headers

  • Idempotency-Keystring

    A repeat within 24 hours returns the first response.

    at most 255 characters

Request body · application/json

  • billing_emailstring (email)required
  • cancel_urlstring (uri)

    Required unless free_access is true.

  • external_refstringrequired

    The partner's tenant ID. One account per tenant.

  • free_accessboolean

    true: the tenant uses the API free, on the free plan Presslane Suppliers set up for the partner (the plan in GET /v1/plans with free_access: true). The account is active at once and there is no Checkout. 403 if the partner has no free plan.

  • namestringrequired

    Business name.

  • planstring

    Plan code from GET /v1/plans. Required unless free_access is true.

    e.g. starter

  • success_urlstring (uri)

    Where Stripe sends the tenant after paying. Must start with one of the partner's allowed return URLs. Required unless free_access is true.

Responses

200The existing account for this tenant.Show
  • accountAccountrequired
    Child attributes
    • activated_atstring (date-time) | nullrequired

      e.g. 2026-11-09T08:00:00Z

    • allowancesobjectrequired

      Null: unlimited.

      Child attributes
      • api_requests_per_monthinteger | nullrequired
      • linked_variantsinteger | nullrequired
    • billing_emailstringrequired
    • cancel_atstring (date-time) | nullrequired

      e.g. 2026-11-09T08:00:00Z

    • complimentarybooleanrequired

      No charge: true when the partner gave free access, or Presslane Suppliers made the account complimentary.

    • created_atstring (date-time)required

      e.g. 2026-11-09T08:00:00Z

    • ended_atstring (date-time) | nullrequired

      e.g. 2026-11-09T08:00:00Z

    • external_refstringrequired

      The partner's tenant ID.

    • free_accessbooleanrequired

      The partner gave this tenant free access on its free plan (PATCH free_access). The partner can end it; a complimentary account Presslane Suppliers set has complimentary: true and free_access: false, and only Presslane Suppliers can end it.

    • idstringrequired

      e.g. acc_01jd6y…

    • namestringrequired
    • planobject | nullrequired
      Child attributes
      • codestringrequired
      • namestringrequired
    • sandboxbooleanrequired

      A sandbox account, for trying the API: it reads the real catalogue and stock, but its orders are only ever recorded as tests (status test) and never sent to a supplier. Only Presslane Suppliers sets it.

    • scheduled_planobject | nullrequired

      A downgrade waiting for the period end.

      Child attributes
      • codestringrequired
      • fromstring (date-time) | nullrequired

        e.g. 2026-11-09T08:00:00Z

      • namestringrequired
    • statusstringrequired

      active and past_due can use data endpoints; others answer 403 account_suspended.

      One of pending_payment, active, past_due, suspended, cancelled, closed

    • subscriptionobject | nullrequired
      Child attributes
      • cancel_at_period_endbooleanrequired
      • current_period_endstring (date-time) | nullrequired

        e.g. 2026-11-09T08:00:00Z

      • last_payment_errorstring | nullrequired
      • priceobject | nullrequired
        Child attributes
        • amount_minorintegerrequired
        • currencystringrequired
        • intervalstringrequired

          Always month

      • statusstring | nullrequired
      • trial_endstring (date-time) | nullrequired

        e.g. 2026-11-09T08:00:00Z

    • suspended_reasonstring | nullrequired

      One of unpaid, cancelled, locked, manual

    • usageobjectrequired
      Child attributes
      • api_requestsintegerrequired
      • linked_variantsintegerrequired
      • period_endstring (date)required

        e.g. 2026-11-21

      • period_startstring (date)required

        e.g. 2026-11-21

  • checkout_expires_atstring (date-time) | nullrequired

    e.g. 2026-11-09T08:00:00Z

  • checkout_urlstring | nullrequired

    Stripe Checkout. Null when no payment is needed (already active, free access, complimentary or a free plan).

201Created.Show
  • accountAccountrequired
    Child attributes
    • activated_atstring (date-time) | nullrequired

      e.g. 2026-11-09T08:00:00Z

    • allowancesobjectrequired

      Null: unlimited.

      Child attributes
      • api_requests_per_monthinteger | nullrequired
      • linked_variantsinteger | nullrequired
    • billing_emailstringrequired
    • cancel_atstring (date-time) | nullrequired

      e.g. 2026-11-09T08:00:00Z

    • complimentarybooleanrequired

      No charge: true when the partner gave free access, or Presslane Suppliers made the account complimentary.

    • created_atstring (date-time)required

      e.g. 2026-11-09T08:00:00Z

    • ended_atstring (date-time) | nullrequired

      e.g. 2026-11-09T08:00:00Z

    • external_refstringrequired

      The partner's tenant ID.

    • free_accessbooleanrequired

      The partner gave this tenant free access on its free plan (PATCH free_access). The partner can end it; a complimentary account Presslane Suppliers set has complimentary: true and free_access: false, and only Presslane Suppliers can end it.

    • idstringrequired

      e.g. acc_01jd6y…

    • namestringrequired
    • planobject | nullrequired
      Child attributes
      • codestringrequired
      • namestringrequired
    • sandboxbooleanrequired

      A sandbox account, for trying the API: it reads the real catalogue and stock, but its orders are only ever recorded as tests (status test) and never sent to a supplier. Only Presslane Suppliers sets it.

    • scheduled_planobject | nullrequired

      A downgrade waiting for the period end.

      Child attributes
      • codestringrequired
      • fromstring (date-time) | nullrequired

        e.g. 2026-11-09T08:00:00Z

      • namestringrequired
    • statusstringrequired

      active and past_due can use data endpoints; others answer 403 account_suspended.

      One of pending_payment, active, past_due, suspended, cancelled, closed

    • subscriptionobject | nullrequired
      Child attributes
      • cancel_at_period_endbooleanrequired
      • current_period_endstring (date-time) | nullrequired

        e.g. 2026-11-09T08:00:00Z

      • last_payment_errorstring | nullrequired
      • priceobject | nullrequired
        Child attributes
        • amount_minorintegerrequired
        • currencystringrequired
        • intervalstringrequired

          Always month

      • statusstring | nullrequired
      • trial_endstring (date-time) | nullrequired

        e.g. 2026-11-09T08:00:00Z

    • suspended_reasonstring | nullrequired

      One of unpaid, cancelled, locked, manual

    • usageobjectrequired
      Child attributes
      • api_requestsintegerrequired
      • linked_variantsintegerrequired
      • period_endstring (date)required

        e.g. 2026-11-21

      • period_startstring (date)required

        e.g. 2026-11-21

  • checkout_expires_atstring (date-time) | nullrequired

    e.g. 2026-11-09T08:00:00Z

  • checkout_urlstring | nullrequired

    Stripe Checkout. Null when no payment is needed (already active, free access, complimentary or a free plan).

  • 400The request is not valid (invalid_request).
  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 409Conflict, including a reused Idempotency-Key (idempotency_conflict).
  • 429Too many requests (rate_limited); see Retry-After.
Request
curl -sS -X POST 'https://suppliers.presslane.ai/v1/accounts' \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"billing_email":"jo@example.com","external_ref":"string","name":"string","plan":"starter"}'
Response · 200
{
  "account": {
    "activated_at": "2026-11-09T08:00:00Z",
    "allowances": {
      "api_requests_per_month": 1,
      "linked_variants": 1
    },
    "billing_email": "string",
    "cancel_at": "2026-11-09T08:00:00Z",
    "complimentary": false,
    "created_at": "2026-11-09T08:00:00Z",
    "ended_at": "2026-11-09T08:00:00Z",
    "external_ref": "string",
    "free_access": false,
    "id": "acc_01jd6y…",
    "name": "string",
    "plan": {
      "code": "string",
      "name": "string"
    },
    "sandbox": false,
    "scheduled_plan": {
      "code": "string",
      "from": "2026-11-09T08:00:00Z",
      "name": "string"
    },
    "status": "pending_payment",
    "subscription": {
      "cancel_at_period_end": false,
      "current_period_end": "2026-11-09T08:00:00Z",
      "last_payment_error": "string",
      "price": {
        "amount_minor": 1,
        "currency": "string",
        "interval": "month"
      },
      "status": "string",
      "trial_end": "2026-11-09T08:00:00Z"
    },
    "suspended_reason": "unpaid",
    "usage": {
      "api_requests": 1,
      "linked_variants": 1,
      "period_end": "2026-11-21",
      "period_start": "2026-11-21"
    }
  },
  "checkout_expires_at": "2026-11-09T08:00:00Z",
  "checkout_url": "string"
}
Try it in the sandbox

Get an account

get/v1/accounts/{id}

Status, plan, allowances and usage this period.

Called by
Partner client
Scope
accounts:read

Path parameters

  • idstringrequired

    Account ID (acc_…).

Responses

200The account.Show
  • activated_atstring (date-time) | nullrequired

    e.g. 2026-11-09T08:00:00Z

  • allowancesobjectrequired

    Null: unlimited.

    Child attributes
    • api_requests_per_monthinteger | nullrequired
    • linked_variantsinteger | nullrequired
  • billing_emailstringrequired
  • cancel_atstring (date-time) | nullrequired

    e.g. 2026-11-09T08:00:00Z

  • complimentarybooleanrequired

    No charge: true when the partner gave free access, or Presslane Suppliers made the account complimentary.

  • created_atstring (date-time)required

    e.g. 2026-11-09T08:00:00Z

  • ended_atstring (date-time) | nullrequired

    e.g. 2026-11-09T08:00:00Z

  • external_refstringrequired

    The partner's tenant ID.

  • free_accessbooleanrequired

    The partner gave this tenant free access on its free plan (PATCH free_access). The partner can end it; a complimentary account Presslane Suppliers set has complimentary: true and free_access: false, and only Presslane Suppliers can end it.

  • idstringrequired

    e.g. acc_01jd6y…

  • namestringrequired
  • planobject | nullrequired
    Child attributes
    • codestringrequired
    • namestringrequired
  • sandboxbooleanrequired

    A sandbox account, for trying the API: it reads the real catalogue and stock, but its orders are only ever recorded as tests (status test) and never sent to a supplier. Only Presslane Suppliers sets it.

  • scheduled_planobject | nullrequired

    A downgrade waiting for the period end.

    Child attributes
    • codestringrequired
    • fromstring (date-time) | nullrequired

      e.g. 2026-11-09T08:00:00Z

    • namestringrequired
  • statusstringrequired

    active and past_due can use data endpoints; others answer 403 account_suspended.

    One of pending_payment, active, past_due, suspended, cancelled, closed

  • subscriptionobject | nullrequired
    Child attributes
    • cancel_at_period_endbooleanrequired
    • current_period_endstring (date-time) | nullrequired

      e.g. 2026-11-09T08:00:00Z

    • last_payment_errorstring | nullrequired
    • priceobject | nullrequired
      Child attributes
      • amount_minorintegerrequired
      • currencystringrequired
      • intervalstringrequired

        Always month

    • statusstring | nullrequired
    • trial_endstring (date-time) | nullrequired

      e.g. 2026-11-09T08:00:00Z

  • suspended_reasonstring | nullrequired

    One of unpaid, cancelled, locked, manual

  • usageobjectrequired
    Child attributes
    • api_requestsintegerrequired
    • linked_variantsintegerrequired
    • period_endstring (date)required

      e.g. 2026-11-21

    • period_startstring (date)required

      e.g. 2026-11-21

  • 400The request is not valid (invalid_request).
  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 404Not found (not_found).
  • 429Too many requests (rate_limited); see Retry-After.
Request
curl -sS -X GET 'https://suppliers.presslane.ai/v1/accounts/{id}' \
  -H "Authorization: Bearer $TOKEN"
Response · 200
{
  "activated_at": "2026-11-09T08:00:00Z",
  "allowances": {
    "api_requests_per_month": 1,
    "linked_variants": 1
  },
  "billing_email": "string",
  "cancel_at": "2026-11-09T08:00:00Z",
  "complimentary": false,
  "created_at": "2026-11-09T08:00:00Z",
  "ended_at": "2026-11-09T08:00:00Z",
  "external_ref": "string",
  "free_access": false,
  "id": "acc_01jd6y…",
  "name": "string",
  "plan": {
    "code": "string",
    "name": "string"
  },
  "sandbox": false,
  "scheduled_plan": {
    "code": "string",
    "from": "2026-11-09T08:00:00Z",
    "name": "string"
  },
  "status": "pending_payment",
  "subscription": {
    "cancel_at_period_end": false,
    "current_period_end": "2026-11-09T08:00:00Z",
    "last_payment_error": "string",
    "price": {
      "amount_minor": 1,
      "currency": "string",
      "interval": "month"
    },
    "status": "string",
    "trial_end": "2026-11-09T08:00:00Z"
  },
  "suspended_reason": "unpaid",
  "usage": {
    "api_requests": 1,
    "linked_variants": 1,
    "period_end": "2026-11-21",
    "period_start": "2026-11-21"
  }
}
Try it in the sandbox

Change plan, free access, suspend, resume or cancel at period end

patch/v1/accounts/{id}

Upgrades take effect at once with proration; downgrades at the next period, and only if linked variants fit the lower allowance (403 allowance_exceeded). suspended: true is the platform lock: the account is suspended at once and billing stops. free_access gives or ends free access (403 when the partner has no free plan; 409 to change plan while it is on, or on a complimentary account Presslane Suppliers set).

Called by
Partner client
Scope
accounts:write

Path parameters

  • idstringrequired

    Account ID (acc_…).

Request body · application/json

  • billing_emailstring
  • cancel_at_period_endboolean

    true when the tenant switches the module off.

  • free_accessboolean

    true: the tenant uses the API free, on the partner's free plan; a subscription it pays is paused (no charge). false: it pays again: a paused subscription resumes on its own plan and the status follows Stripe; with none, the account goes to pending_payment (data endpoints stop) until the tenant pays through Checkout (POST /v1/accounts with a plan). Not with plan in the same request.

  • namestring
  • planstring

    Upgrades take effect now with proration; downgrades at the next period, if linked variants fit.

  • suspendedboolean

    true: the platform lock — suspends at once and stops billing. false: resume.

Responses

200The account after the change.Show
  • activated_atstring (date-time) | nullrequired

    e.g. 2026-11-09T08:00:00Z

  • allowancesobjectrequired

    Null: unlimited.

    Child attributes
    • api_requests_per_monthinteger | nullrequired
    • linked_variantsinteger | nullrequired
  • billing_emailstringrequired
  • cancel_atstring (date-time) | nullrequired

    e.g. 2026-11-09T08:00:00Z

  • complimentarybooleanrequired

    No charge: true when the partner gave free access, or Presslane Suppliers made the account complimentary.

  • created_atstring (date-time)required

    e.g. 2026-11-09T08:00:00Z

  • ended_atstring (date-time) | nullrequired

    e.g. 2026-11-09T08:00:00Z

  • external_refstringrequired

    The partner's tenant ID.

  • free_accessbooleanrequired

    The partner gave this tenant free access on its free plan (PATCH free_access). The partner can end it; a complimentary account Presslane Suppliers set has complimentary: true and free_access: false, and only Presslane Suppliers can end it.

  • idstringrequired

    e.g. acc_01jd6y…

  • namestringrequired
  • planobject | nullrequired
    Child attributes
    • codestringrequired
    • namestringrequired
  • sandboxbooleanrequired

    A sandbox account, for trying the API: it reads the real catalogue and stock, but its orders are only ever recorded as tests (status test) and never sent to a supplier. Only Presslane Suppliers sets it.

  • scheduled_planobject | nullrequired

    A downgrade waiting for the period end.

    Child attributes
    • codestringrequired
    • fromstring (date-time) | nullrequired

      e.g. 2026-11-09T08:00:00Z

    • namestringrequired
  • statusstringrequired

    active and past_due can use data endpoints; others answer 403 account_suspended.

    One of pending_payment, active, past_due, suspended, cancelled, closed

  • subscriptionobject | nullrequired
    Child attributes
    • cancel_at_period_endbooleanrequired
    • current_period_endstring (date-time) | nullrequired

      e.g. 2026-11-09T08:00:00Z

    • last_payment_errorstring | nullrequired
    • priceobject | nullrequired
      Child attributes
      • amount_minorintegerrequired
      • currencystringrequired
      • intervalstringrequired

        Always month

    • statusstring | nullrequired
    • trial_endstring (date-time) | nullrequired

      e.g. 2026-11-09T08:00:00Z

  • suspended_reasonstring | nullrequired

    One of unpaid, cancelled, locked, manual

  • usageobjectrequired
    Child attributes
    • api_requestsintegerrequired
    • linked_variantsintegerrequired
    • period_endstring (date)required

      e.g. 2026-11-21

    • period_startstring (date)required

      e.g. 2026-11-21

  • 400The request is not valid (invalid_request).
  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 404Not found (not_found).
  • 409Conflict, including a reused Idempotency-Key (idempotency_conflict).
  • 429Too many requests (rate_limited); see Retry-After.
Request
curl -sS -X PATCH 'https://suppliers.presslane.ai/v1/accounts/{id}' \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{}'
Response · 200
{
  "activated_at": "2026-11-09T08:00:00Z",
  "allowances": {
    "api_requests_per_month": 1,
    "linked_variants": 1
  },
  "billing_email": "string",
  "cancel_at": "2026-11-09T08:00:00Z",
  "complimentary": false,
  "created_at": "2026-11-09T08:00:00Z",
  "ended_at": "2026-11-09T08:00:00Z",
  "external_ref": "string",
  "free_access": false,
  "id": "acc_01jd6y…",
  "name": "string",
  "plan": {
    "code": "string",
    "name": "string"
  },
  "sandbox": false,
  "scheduled_plan": {
    "code": "string",
    "from": "2026-11-09T08:00:00Z",
    "name": "string"
  },
  "status": "pending_payment",
  "subscription": {
    "cancel_at_period_end": false,
    "current_period_end": "2026-11-09T08:00:00Z",
    "last_payment_error": "string",
    "price": {
      "amount_minor": 1,
      "currency": "string",
      "interval": "month"
    },
    "status": "string",
    "trial_end": "2026-11-09T08:00:00Z"
  },
  "suspended_reason": "unpaid",
  "usage": {
    "api_requests": 1,
    "linked_variants": 1,
    "period_end": "2026-11-21",
    "period_start": "2026-11-21"
  }
}
Try it in the sandbox

Issue account API credentials

post/v1/accounts/{id}/clients

The secret is returned once. An account can hold several clients; revoke old ones after swapping.

Called by
Partner client
Scope
accounts:write

Path parameters

  • idstringrequired

    Account ID (acc_…).

Headers

  • Idempotency-Keystring

    A repeat within 24 hours returns the first response.

    at most 255 characters

Request body · application/json

  • namestring
  • scopesarray of string

    Default: every account scope.

    One of catalogue:read, stock:read, links:write, links:read, webhooks:write, usage:read, orders:write, orders:read

Responses

201The new client, with its secret.Show
  • client_idstringrequired
  • client_secretstring

    Returned once, when created. Store it encrypted.

  • created_atstring (date-time)required

    e.g. 2026-11-09T08:00:00Z

  • namestringrequired
  • revoked_atstring (date-time) | nullrequired

    e.g. 2026-11-09T08:00:00Z

  • scopesarray of stringrequired
  • statusstringrequired

    One of active, revoked

  • 400The request is not valid (invalid_request).
  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 404Not found (not_found).
  • 409Conflict, including a reused Idempotency-Key (idempotency_conflict).
  • 429Too many requests (rate_limited); see Retry-After.
Request
curl -sS -X POST 'https://suppliers.presslane.ai/v1/accounts/{id}/clients' \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{}'
Response · 201
{
  "client_id": "string",
  "created_at": "2026-11-09T08:00:00Z",
  "name": "string",
  "revoked_at": "2026-11-09T08:00:00Z",
  "scopes": [
    "string"
  ],
  "status": "active"
}
Try it in the sandbox

Revoke account credentials

DEL/v1/accounts/{id}/clients/{client_id}

The client can get no new tokens, and its existing tokens stop working within 60 seconds.

Called by
Partner client
Scope
accounts:write

Path parameters

  • idstringrequired

    Account ID (acc_…).

  • client_idstringrequired

    Client ID (cli_…).

Responses

204Revoked.
  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 404Not found (not_found).
  • 429Too many requests (rate_limited); see Retry-After.
Request
curl -sS -X DELETE 'https://suppliers.presslane.ai/v1/accounts/{id}/clients/{client_id}' \
  -H "Authorization: Bearer $TOKEN"
Try it in the sandbox

List plans on sale

get/v1/plans

Prices exclude VAT. Allowances are per month; null is unlimited. When Presslane Suppliers set up free access for the partner, its free plan is listed too, with free_access: true.

Called by
Partner client
Scope
accounts:read

Responses

200Plans on sale.Show
  • dataarray of Planrequired
    Child attributes
    • api_requests_per_monthinteger | nullrequired

      Null: unlimited.

    • codestringrequired
    • descriptionstring | nullrequired
    • free_accessbooleanrequired

      true: the partner's own free plan, for tenants it gives free access. Not for sale: use free_access: true, not this plan's code.

    • idstringrequired
    • linked_variants_includedinteger | nullrequired

      Null: unlimited.

    • namestringrequired
    • priceobject | nullrequired

      Excluding VAT.

      Child attributes
      • amount_minorintegerrequired
      • currencystringrequired
      • intervalstringrequired

        Always month

      • taxstringrequired

        Always exclusive

    • sync_interval_minutesintegerrequired
    • trial_daysintegerrequired
  • 400The request is not valid (invalid_request).
  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 429Too many requests (rate_limited); see Retry-After.
Request
curl -sS -X GET 'https://suppliers.presslane.ai/v1/plans' \
  -H "Authorization: Bearer $TOKEN"
Response · 200
{
  "data": [
    {
      "api_requests_per_month": 1,
      "code": "string",
      "description": "string",
      "free_access": false,
      "id": "string",
      "linked_variants_included": 1,
      "name": "string",
      "price": {
        "amount_minor": 1,
        "currency": "string",
        "interval": "month",
        "tax": "exclusive"
      },
      "sync_interval_minutes": 1,
      "trial_days": 1
    }
  ]
}
Try it in the sandbox