Sync & Track Subscriptions

Automatically sync new customers and subscriptions to Received.

Step 1: Automatically Sync Customers and Subscriptions

Once you have embedded the custom URLs into your website, Received's platform is ready to automatically 'catch' user information and create new customers and subscriptions. Using APIs, we can access the subscription data from your website to create the following:

1. New Customer Using a specific API, a new customer is automatically created in Customers > Subscriptions. Our API looks like this:

// POST/api/customers

Request body

Example Value

{
  "name": "Received",
  "legal_name": "Received ltd.",
  "email": "[e-mail], [e-mail]",
  "ein": "12-3456789",
  "phone": {
    "countryCode": "1",
    "phone": "2121234567"
  },
  "country": "United States",
  "city": "New York",
  "zip_code": "string",
  "billing_address": "643 Mundy St, Watertown, New York(NY), 13601",
  "shipping_address": "643 Mundy St, Watertown, New York(NY), 13601",
  "country_state": "NY",
  "currency": "USD",
  "tax": 17,
  "entity_ref": "693122c3-54e0-4acd-aeb8-7de4686cea3e",
  "entity_name": "Acme Inc",
  "net_terms": 30,
  "settings": {
    "attach_usage_logs_csv": false,
    "attach_usage_logs_pdf": true
  },
  "icon_data": "string"
}

Responses

Example Value

{
  "customer_ref": "dcaff9c0-4a9c-4d01-b2dc-0da7efcc616c"
}

1. New Subscription Using a specific API, a new subscription is automatically created in Contracts > Subscriptions. Our API looks like this:

// POST/api/contracts/subscriptions

Request body

Example Value

{
  "customer_ref": "19ed1ce4-082b-4cea-8dfb-c7e673f88224",
  "entity_ref": "cec40f99-a2e1-4bd7-805d-9c1a3c2e69a1",
  "po_number": "string",
  "billing_start_date": "2024-02-01T12:05:23.613Z",
  "billing_end_date": "2024-02-01T12:05:23.613Z",
  "issue_day": "2023-07-13",
  "payment_time": "AFTER_USE",
  "tax": 17,
  "discount": 0,
  "net_terms": "DUE_UPON_RECEIPT",
  "note": "string",
  "billing_online_payment_details": {
    "auto_charge": true,
    "payment_gateway_id": "string",
    "payment_gateway_card_id": "string"
  },
  "products": [
    {
      "product_pricing_ref": "string",
      "line_items": [
        {
          "line_item_id": "string"
        }
      ]
    }
  ]
}

Responses

Example Value

{
  "subscription_ref": "32c320bb-431b-488f-bcd4-729e495a33ad"
}

Step 2: Track Subscriptions Data

Navigate to Customers>Subscribers to see all subscriptions data. On this screen you can view the number of subscribers, subscriptions ARR and MRR, payment status, churn rate and more. Received offers an error handling mechanism, which quickly identifies failed payments and automatically sends a new payment link to the customer.