Skip to content
Space Invoices Documentation

White-Label Subscriptions

White-Label Subscriptions

Entity-level subscription management for white-label products.

Endpoints
IntroductionGET/white-label-subscriptionsGET/white-label-subscriptions/plansGET/white-label-subscriptions/check-feature/{feature}GET/white-label-subscriptions/check-limit/{resource}

The White-Label Subscription object

object

Attributes

featurestring

Feature being checked

allowedboolean

Whether the feature is allowed on the current plan

requires_upgradeboolean

Whether an upgrade is needed to access this feature

Other attributes
upgrade_plan_slugstring

Get current subscription

GET/white-label-subscriptions

Returns the current entity subscription with plan details and usage stats. Requires entity context.

Response

Returns

planobject
statusstring
billing_intervalstring
current_period_startstring
current_period_endstring
trial_ends_atstring
trial_days_remaininginteger
cancel_atstring
payment_methodobject
store_billingobject
usageobject
json
{
  "plan": {
    "id": "string",
    "slug": "string",
    "name": "string",
    "billing_interval": "string",
    "base_price_cents": 0,
    "limits": {
      "documents_per_month": 0,
      "invoices_per_month": 0,
      "overage_price_cents": 0,
      "annual_price_cents": 0,
      "included_store_count": 0,
      "extra_store_price_cents": 0,
      "extra_store_annual_price_cents": 0,
      "extra_store_invoices_per_month": 0
    },
    "features": [
      "string"
    ],
    "is_free": true,
    "display_order": 0
  },
  "status": "string",
  "billing_interval": "string",
  "current_period_start": "string",
  "current_period_end": "string",
  "trial_ends_at": "string",
  "trial_days_remaining": 0,
  "cancel_at": "string",
  "payment_method": {
    "last4": "string",
    "brand": "string",
    "has_card": true
  },
  "store_billing": {
    "connected_stores": 0,
    "included_stores": 0,
    "billable_extra_stores": 0,
    "invoices_included_from_extra_stores": 0,
    "extra_store_price_cents_monthly": 0,
    "extra_store_price_cents_yearly": 0
  },
  "usage": {
    "documents_count": 0,
    "documents_limit": 0,
    "invoices_count": 0,
    "invoices_limit": 0,
    "period_start": "string",
    "period_end": "string"
  }
}

Get available plans

GET/white-label-subscriptions/plans

Returns available subscription plans for the current white-label.

Response

Returns

plansarray of objects
current_plan_slugstring
json
{
  "plans": [
    {
      "id": "string",
      "slug": "string",
      "name": "string",
      "billing_interval": "string",
      "base_price_cents": 0,
      "limits": {
        "documents_per_month": 0,
        "invoices_per_month": 0,
        "overage_price_cents": 0,
        "annual_price_cents": 0,
        "included_store_count": 0,
        "extra_store_price_cents": 0,
        "extra_store_annual_price_cents": 0,
        "extra_store_invoices_per_month": 0
      },
      "features": [
        "string"
      ],
      "is_free": true,
      "display_order": 0
    }
  ],
  "current_plan_slug": "string"
}

Check feature access

GET/white-label-subscriptions/check-feature/{feature}

Checks if a specific feature is available on the current subscription plan.

Request

Path parameters

featurestringrequired

Feature slug to check

curl "https://eu.spaceinvoices.com/white-label-subscriptions/check-feature/{feature}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"
Response

Returns

featurestring
allowedboolean
requires_upgradeboolean
upgrade_plan_slugstring
json
{
  "feature": "string",
  "allowed": true,
  "requires_upgrade": true,
  "upgrade_plan_slug": "string"
}

Check resource limit

GET/white-label-subscriptions/check-limit/{resource}

Checks if the current usage allows creating more of a resource type.

Request

Path parameters

resourcestringrequired

Resource type to check (e.g., 'documents')

curl "https://eu.spaceinvoices.com/white-label-subscriptions/check-limit/{resource}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"
Response

Returns

resourcestring
allowedboolean
usageinteger
limitinteger
percentagenumber
json
{
  "resource": "string",
  "allowed": true,
  "usage": 0,
  "limit": 0,
  "percentage": 0
}