For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

PropelBiz

PropelBiz 25platform Billing Saa S Tenant

Show Subscription

||View as Markdown|

GET

/companies/%7Bcompany_uuid%7D/config/billing/subscription/%7Bsubscription_uuid%7D

GET

/companies/%7Bcompany_uuid%7D/config/billing/subscription/%7Bsubscription_uuid%7D

1 curl https://https//https/companies/%7Bcompany_uuid%7D/config/billing/subscription/%7Bsubscription_uuid%7D \
2      -H "{{tenant_key_name}}: {{tenant_key_value1}}|{{tenant_key_value2}}" \
3      -H "Content-Type: application/json"

200Retrieved

1 {
2   "subscriptionId": "a3f1c9d2-4b7e-4f8a-9c3d-2e5f7b8a9c1d",
3   "companyId": "d9b2d63d-a233-4123-847a-7a9a5f3c1e2b",
4   "planName": "Pro Annual",
5   "status": "active",
6   "startDate": "2023-11-01T00:00:00Z",
7   "endDate": "2024-11-01T00:00:00Z",
8   "autoRenew": true,
9   "billingCycle": "annual",
10   "amount": 1200,
11   "currency": "USD",
12   "paymentMethod": "credit_card",
13   "lastPaymentDate": "2023-11-01T00:00:00Z",
14   "nextBillingDate": "2024-11-01T00:00:00Z"
15 }

Headers

{{tenant_key_name}}stringOptional

Response

Successful response

Was this page helpful?

Invoice PDF

Update Subscription