Saaslogic
  1. Subscriptions
Saaslogic
  • Introduction
  • Authentication
  • Enum Reference
  • Authentication
    • saaslogic token
      • Get the saaslogic access token
    • login Url
      • Gives the login URL
    • logout Url
      • Gives the logout URL
  • Countries
    • Get list of countries
  • Plans
    • List all plans for a product
  • Subscriptions
    • Create a product subscription
      POST
    • Retrieve a subscription
      GET
    • Create Customer and Subscription
      POST
    • Subscription with details permissions, menus and features
      GET
    • The Saaslogic URL for creating subscription
      POST
  • Usage Reporting
    • Report the resource usages in subscription for invoicing
    • Retrieves the resource usages of a subscription in the current billing cycle
  • Customers
    • addresses
      • Create an address
      • List all addresses
      • Update an address
      • Retrieve an address
      • Delete an address
    • contacts
      • Create a contact
      • List all contacts
      • Update a contact
      • Retrieve a contact
      • Delete a contact
    • Create a customer
    • List all customers
    • Update a customer
    • Retrieve a customer
    • Delete a customer
  • Vendors
    • vendor addresses
      • Create a vendor address.
      • List all vendor addresses.
      • Update a vendor address.
      • Retrieve a vendor address..
      • Delete a vendor address.
    • vendor contacts
      • Create a vendor contact.
      • List all vendor contacts.
      • Update a vendor contact.
      • Retrieve a vendor contact.
      • Delete a vendor contact.
    • vendor bills
      • Create a vendor bill
      • Cancel a vendor bill.
    • vendor bills payout
      • Update payment details to vendor bills.
    • Create a vendor
    • Update a vendor.
    • Activate a vendor.
    • Dectivate a vendor.
  • Attributes
    • Create a organization attribute and set the value
    • Retrieve a organization attribute
    • Create a user attribute
    • Update a user attribute
    • Get a user attribute
  • Invoices
    • subscriptions
      • Get the invoices
      • Get the invoices by subscription
    • payments
      • Mark the invoice payment status
    • Get the invoice details .
    • cancel the invoices
    • Send invoice as pdf with payment link.
    • Create an on-demand invoice
  1. Subscriptions

Create a product subscription

POST
/subscriptions
Subscriptions
Creating new subscription
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-sandbox.saaslogic.io/v1/subscriptions' \
--header 'Authorization;' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerId": "550e8400-e29b-41d4-a716-446655440000",
    "productId": "2a9d72c5-1c78-4b1b-bd12-4f4d76e9c2b7",
    "customerAddressId": "c0a80123-12b4-4c56-abc7-89d4ef567890",
    "planId": "d6f7e5a1-3c47-4a78-9b23-67f3e2d5a4b8",
    "billingFrequencyId": "9f8b7a6c-5d4e-4c3b-8a2b-1f0d9e7c6a5b",
    "subscriptionId": "7a3e2b1c-8d4f-5a6b-9f0e-2c7d1a4b3c8d",
    "subscriptionStartDate": "2025-03-18T00:00:00",
    "billingCycleStartDate": "2025-03-01T00:00:00",
    "isAutoRenewEnabled": true,
    "subscriptionAttributes": [
        {
            "attributeName": "Contract Type",
            "attributeValue": "Annual"
        }
    ],
    "resourceQuantities": [
        {
            "resourceId": "5d2b3a1e-8c4f-6b7a-9f0e-2c1d4a3b8c7d",
            "quantity": "200"
        }
    ],
    "addons": [
        {
            "addonId": "3e7a2b1c-9d4f-5a6b-0f1e-2c7d8a4b3c8d"
        }
    ],
    "isTrail": false,
    "couponCode": "SAVE20",
    "isGenerateInvoiceForCurrentCycle": false
}'
Response Response Example
{
  "message": "UN_AUTHORIZED"
}

Request

Header Params
Authorization
string 
required
Saaslogic authorization token
Default:
Bearer {{bearerToken}}
Content-Type
string 
optional
Default:
application/json
Accept
string 
optional
Default:
application/json
Body Params application/json
customerId
string 
required
The ID of the Customer
Example:
550e8400-e29b-41d4-a716-446655440000
productId
string 
required
The ID of the Product
Example:
2a9d72c5-1c78-4b1b-bd12-4f4d76e9c2b7
customerAddressId
string 
required
The ID of the Customer Address
Example:
c0a80123-12b4-4c56-abc7-89d4ef567890
planId
string 
required
The ID of the Plan
Example:
d6f7e5a1-3c47-4a78-9b23-67f3e2d5a4b8
billingFrequencyId
string 
required
The ID of the Billing Frequency
Example:
9f8b7a6c-5d4e-4c3b-8a2b-1f0d9e7c6a5b
subscriptionId
string 
optional
The ID of the Subscription
Example:
7a3e2b1c-8d4f-5a6b-9f0e-2c7d1a4b3c8d
subscriptionStartDate
string <yyyy-MM-dd'T'HH:mm:ss>
optional
The start date of the subscription
Example:
2025-03-18T00:00:00
billingCycleStartDate
string <yyyy-MM-dd'T'HH:mm:ss>
optional
The start date of the billing cycle. This filed is only applicable to backdated subscription.
Example:
2025-03-01T00:00:00
isAutoRenewEnabled
boolean 
optional
Indicates whether the subscription is set to auto-renew (true/false)
subscriptionAttributes
array [object {2}] 
optional
List of attributes and their values associated with the subscription
attributeName
string 
optional
The attribute name of the subscription
Example:
Contract Type
attributeValue
string 
optional
The attribute value of the subscription
Example:
Annual
resourceQuantities
array [object {2}] 
optional
List of resources and their quantities associated with the subscription
resourceId
string 
optional
The ID of the resource
Example:
5d2b3a1e-8c4f-6b7a-9f0e-2c1d4a3b8c7d
quantity
string 
optional
The quantity of the resource subscribed
Example:
200
addons
array [object {1}] 
optional
List of addons associated with the subscription
addonId
string 
optional
The ID of the addon
Example:
3e7a2b1c-9d4f-5a6b-0f1e-2c7d8a4b3c8d
isTrail
boolean 
optional
Indicates whether the subscription is a trial (true/false)
Default:
false
couponCode
string 
write-onlyoptional
The coupon code applied to the subscription, if any
Example:
SAVE20
isGenerateInvoiceForCurrentCycle
boolean 
write-onlyoptional
Indicates whether the subscription need to generate invoice (true/false). This field is only applicable to backdated subscription
Default:
false
Examples

Responses

🟢200Subscription Created
text/plain
SUBSCRIPTION_CREATED_SUCCESSFULLY
Body
object {0}
🔴500ErrorResponse
Previous
List all plans for a product
Next
Retrieve a subscription
Built with