Get 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>"
        }
      ]
    }
  ],
  "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

Subscription estimate serializer from OrderPricing

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

billing_schedule
object[]
required

The billing schedule of the subscription

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 Customer output serializer; we can represent the customer model differently depending on the request so we need a custom serializer for the output.

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
terminates_at
string<date>
required

Date of termination

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

signatory_user
object
required

User who signed the subscription agreement

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
metadata
any

Optional metadata to add to the subscription.