Get the current subscription state

curl --request GET \
  --url https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/current \
  --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>"
        }
      ],
      "pre_commitment_schedule": "<string>"
    }
  ],
  "billing_schedule": [
    {
      "starts_at": "<string>",
      "ends_at": "<string>",
      "sub_total": 123,
      "grand_total": "<string>",
      "grand_total_details": "<string>"
    }
  ],
  "grand_total_details": "<unknown>",
  "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer": {
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "external_id": "<string>",
    "address": {
      "line_1": "<string>",
      "city": "<string>",
      "region": "<string>",
      "zip": "<string>",
      "country": "<string>",
      "line_2": "<string>"
    },
    "stripe_customer_id": "<string>"
  },
  "renews_at": "2023-12-25",
  "status": "ACTIVE",
  "stage": "BUILDING",
  "transaction_method": "ORDER_FORM",
  "terminates_at": "2023-12-25",
  "time_zone": "<string>",
  "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": "[email protected]",
    "role": "<string>",
    "preferred_name": "<string>"
  },
  "products": [
    {
      "name": "<string>",
      "logo_image": "<string>"
    }
  ],
  "signatory_user": {
    "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "[email protected]",
    "role": "<string>",
    "preferred_name": "<string>"
  },
  "accounts_payable_emails": [
    "[email protected]"
  ],
  "currency": "USD",
  "payment_terms": 123,
  "auto_renews": true,
  "metadata": "<unknown>"
}

GET

api

subscriptions

{subscription_id}

current

Get the current subscription state

curl --request GET \
  --url https://api.salesbricks.com/api/v2/subscriptions/{subscription_id}/current \
  --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>"
        }
      ],
      "pre_commitment_schedule": "<string>"
    }
  ],
  "billing_schedule": [
    {
      "starts_at": "<string>",
      "ends_at": "<string>",
      "sub_total": 123,
      "grand_total": "<string>",
      "grand_total_details": "<string>"
    }
  ],
  "grand_total_details": "<unknown>",
  "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer": {
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "external_id": "<string>",
    "address": {
      "line_1": "<string>",
      "city": "<string>",
      "region": "<string>",
      "zip": "<string>",
      "country": "<string>",
      "line_2": "<string>"
    },
    "stripe_customer_id": "<string>"
  },
  "renews_at": "2023-12-25",
  "status": "ACTIVE",
  "stage": "BUILDING",
  "transaction_method": "ORDER_FORM",
  "terminates_at": "2023-12-25",
  "time_zone": "<string>",
  "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": "[email protected]",
    "role": "<string>",
    "preferred_name": "<string>"
  },
  "products": [
    {
      "name": "<string>",
      "logo_image": "<string>"
    }
  ],
  "signatory_user": {
    "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "[email protected]",
    "role": "<string>",
    "preferred_name": "<string>"
  },
  "accounts_payable_emails": [
    "[email protected]"
  ],
  "currency": "USD",
  "payment_terms": 123,
  "auto_renews": true,
  "metadata": "<unknown>"
}

Authorizations

X-SALESBRICKS-KEY

string

header

required

API key for authentication

Path Parameters

subscription_id

string

required

Response

Subscription detail serializer.

ends_at

string<date>

required

End date of subscription

sub_total

integer

required

Subtotal before taxes and discounts

grand_total

integer

required

Final total after taxes and discounts

line_items

object[]

required

The line items of the subscription

Show child attributes

line_items.quantity

integer

required

The quantity of the brick

line_items.brick_id

string<uuid>

required

The brick id

line_items.brick_name

string

required

The name of the brick

line_items.sub_total

integer

required

Subtotal for the line item before taxes and discounts

line_items.plan_id

string

required

ID of the plan this line item belongs to

line_items.plan_name

string

required

Name of the plan this line item belongs to

line_items.grand_total

string

required

Final total for the line item after taxes and discounts

line_items.grand_total_details

string

required

Breakdown containing total discount amounts for the line item

line_items.tiers_breakdown

object[]

required

Tiers breakdown for the line item

Show child attributes

line_items.tiers_breakdown.quantity

integer

required

Number of units in this tier

line_items.tiers_breakdown.unit_price

string<decimal>

required

Unit price for this tier

line_items.tiers_breakdown.sub_total

string<decimal>

required

Subtotal for this tier

line_items.tiers_breakdown.duration_text

string

required

Duration text for frontend display

line_items.pre_commitment_schedule

string | null

required

The pre-commitment schedule for usage-based line items

billing_schedule

object[]

required

The billing schedule of the subscription

Show child attributes

billing_schedule.starts_at

string

required

Start date of the billing period

billing_schedule.ends_at

string

required

End date of the billing period

billing_schedule.sub_total

integer

required

Subtotal for the billing period before taxes and discounts

billing_schedule.grand_total

string

required

Final total for the billing period after taxes and discounts

billing_schedule.grand_total_details

string

required

Breakdown containing total discount for the billing period

grand_total_details

any

required

Breakdown containing total discount and tax amounts

subscription_id

string<uuid>

required

Unique identifier for the subscription

customer

object

required

Customer details

Show child attributes

customer.customer_id

string<uuid>

required

customer.name

string

required

customer.external_id

string | null

Maximum string length: 255

customer.address

object

The address of the customer

Show child attributes

customer.address.line_1

string

required

The first line of the address input

customer.address.city

string

required

The city of the address input

customer.address.region

string

required

The region (ISO 3166: 2 character code) of the address input

customer.address.zip

string

required

The zip code of the address input

customer.address.country

string

required

The country (ISO 3166: 2 character code) of the address input

customer.address.line_2

string | null

The second line of the address input

customer.stripe_customer_id

string | null

The companies stripe customer_id

Maximum string length: 255

renews_at

string<date>

required

Date of renewal

status

enum<string>

required

Current status of the subscription

ACTIVE - Active
ORDER_NEEDED - Order needed
OPEN_ORDER - Open order
SCHEDULED - Scheduled
TERMINATED - Terminated
TERMINATING - Terminating
INACTIVE - Inactive

Available options:

ACTIVE,

ORDER_NEEDED,

OPEN_ORDER,

SCHEDULED,

TERMINATED,

TERMINATING,

INACTIVE

stage

enum<string>

required

Current stage of the subscription

BUILDING - Open
CLOSED - Closed Won
CLOSED_LOST - Closed Lost
CLOSED_DELETE - Closed Delete
SELLER_SIGNING - Signing
MIGRATING - Migrating

Available options:

BUILDING,

CLOSED,

CLOSED_LOST,

CLOSED_DELETE,

SELLER_SIGNING,

MIGRATING

transaction_method

enum<string>

required

The medium by which the order is agreed.

ORDER_FORM - Order form
STRIPE - Stripe

Available options:

ORDER_FORM,

STRIPE

terminates_at

string<date>

required

Date of termination

time_zone

string

required

Subscription time zone

starts_at

string<date>

required

Start date of subscription

billing_frequency

enum<string>

required

Billing frequency of the subscription

MONTHLY - Monthly
QUARTERLY - Quarterly
SEMI_ANNUALLY - Semi-annually
ANNUALLY - Annually
ALL_UPFRONT - All upfront

Available options:

MONTHLY,

QUARTERLY,

SEMI_ANNUALLY,

ANNUALLY,

ALL_UPFRONT

point_of_contact

object

required

Primary contact person for the subscription

Show child attributes

point_of_contact.person_id

string<uuid>

required

The ID of the person

point_of_contact.first_name

string

required

The first name of the person

point_of_contact.last_name

string

required

The last name of the person

point_of_contact.email

string<email>

required

The email of the person

point_of_contact.role

string

required

The role of the person

point_of_contact.preferred_name

string | null

Maximum string length: 255

products

object[]

required

Product details

Show child attributes

products.name

string

required

Name of the product

products.logo_image

string

required

URL to the product logo image, falls back to seller logo if not set

signatory_user

object

required

User who signed the subscription agreement

Show child attributes

signatory_user.person_id

string<uuid>

required

The ID of the person

signatory_user.first_name

string

required

The first name of the person

signatory_user.last_name

string

required

The last name of the person

signatory_user.email

string<email>

required

The email of the person

signatory_user.role

string

required

The role of the person

signatory_user.preferred_name

string | null

Maximum string length: 255

accounts_payable_emails

string<email>[]

required

List of email addresses for accounts payable contacts

currency

enum<string>

required

The currency used

USD - United States Dollar
EUR - Euros
GBP - Great British Pound
AUD - Australian Dollar
CAD - Canadian Dollar

Available options:

USD,

EUR,

GBP,

AUD,

CAD

payment_terms

integer

required

The payment terms for this susbcription

auto_renews

boolean

required

If the subscription will auto renew at the end of the current contract period

metadata

any

Optional metadata to add to the subscription.

Get brick usage for a subscription.Get subscription invoices

⌘I

Customers

Invoices

Plans

Subscriptions

Payment Methods

Usage

Get the current subscription state

Authorizations

Path Parameters

Response