Get subscription details
curl --request GET \
  --url https://api.salesbricks.com/api/v2/subscriptions/{subscription_id} \
  --header 'X-SALESBRICKS-KEY: <api-key>'
{
  "ends_at": "2023-12-25",
  "sub_total": 123,
  "grand_total": 123,
  "line_items": [
    {
      "quantity": 123,
      "brick_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "brick_name": "<string>",
      "sub_total": 123,
      "plan_id": "<string>",
      "plan_name": "<string>",
      "grand_total": "<string>",
      "grand_total_details": "<string>",
      "tiers_breakdown": [
        {
          "quantity": 123,
          "unit_price": "<string>",
          "sub_total": "<string>",
          "duration_text": "<string>"
        }
      ]
    }
  ],
  "billing_schedule": [
    {
      "starts_at": "<string>",
      "ends_at": "<string>",
      "sub_total": 123,
      "grand_total": "<string>",
      "grand_total_details": "<string>"
    }
  ],
  "grand_total_details": "<any>",
  "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer": {
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "external_id": "<string>",
    "address": {
      "line_1": "<string>",
      "line_2": "<string>",
      "city": "<string>",
      "region": "<string>",
      "zip": "<string>",
      "country": "<string>"
    }
  },
  "metadata": "<any>",
  "renews_at": "2023-12-25",
  "status": "ACTIVE",
  "stage": "BUILDING",
  "terminates_at": "2023-12-25",
  "starts_at": "2023-12-25",
  "billing_frequency": "MONTHLY",
  "point_of_contact": {
    "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "preferred_name": "<string>",
    "role": "<string>"
  },
  "signatory_user": {
    "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "preferred_name": "<string>",
    "role": "<string>"
  },
  "accounts_payable_emails": [
    "jsmith@example.com"
  ],
  "currency": "USD"
}

Authorizations

X-SALESBRICKS-KEY
string
header
required

API key for authentication

Path Parameters

subscription_id
string
required

Response

200
application/json

Subscription estimate serializer from OrderPricing