Cloud Plans
console
  • Cloud Plans Reference
  • What is Cloud Plans
  • Starting with out tutorials
  • User Management
    • MFA
  • Support
  • Organization
    • Create
    • Select
    • Configure
    • Subscription
      • Add / Update
      • Cancel
    • Delete
    • Users
      • Add
      • Manage
      • MFA
    • Credentials
      • Create
        • Create Azure Service Principal
        • Create AWS Role
        • Create Google Cloud Bindings
      • Manage
    • Plans
      • Create
      • Update
      • Add Reources
      • Update Resources
      • Reorder Resources
      • Notifications
    • Jobs
    • History
    • Messages
  • USE
  • API Reference
    • Authentication
    • User
    • Organization
    • Billing
    • Organization Users
    • Credentials
    • Plans
    • Jobs
    • History
    • Messages
  • Terms
Powered by GitBook
On this page
  • Describe Billing
  • Billing History
  • Create subscription
  • Change payment method
  • Update Subscription
  • Cancel Subscription
  1. API Reference

Billing

Describe Billing

GET /v1/organizations/billing/describe?action=getorganization

<Description of the endpoint>

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Description

org_id

string

The Organization ID

Response

{
  "status": 200,
  "response": {
    "organization": {
      "resources": number,
      "name"; "string",
      "id": "string",
      "owner": "string"
    }
    "subscription": {
      "payment_exp": "string";
      "plan": "string";
      "quantity": "string";
    }
  }
}

Billing History

GET /v1/organizations/billing/history

<Description of the endpoint>

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

QueryString

Name
Type
Description

action=list_billing

string

Name of the user

org_id

string

The Organization ID

Response

{
  "status": 200,
  "billing_history": [
    {
      "status": "paid | unpaid",
      "id": "string",
      "organization": "string",
      "date": "string",
      "due_date": "string",
      "amount": "string"
      
    }
  ]
}

Create subscription

POST /v1/organizations/billing/update?action=getpaymentlink

<Description of the endpoint>

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Query String

Name
Type
Description

org_id

string

The ID of the Organization

quantity

number

Number of Instances for subscribing

Response

{
  "status": 200,
  "response": "string" (the payment Link)
}

Change payment method

POST /v1/organizations/billing/update?action=getupdatecardlink

<Description of the endpoint>

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Payload

Name
Type
Description

org_id

string

The Organization ID

Response

{
  "status": 200,
  "response": "string" (the Link for the Update Payment operation)
}

Update Subscription

POST /v1/organizations/billing/update?action=updatesubscription

<Description of the endpoint>

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Payload

Name
Type
Description

org_id

string

The ID of the Organization

quantity

number

The number of instances for the Subscription

Response

{
  "status": 200
}

Cancel Subscription

POST /v1/organizations/billing/update?action=cancelsubscription

<Description of the endpoint>

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Description

org_id

string

The ID of the Organization

Response

{
  "status": 200,
}

PreviousOrganizationNextOrganization Users

Last updated 7 months ago