List Orders

GET

orders

List Orders

curl --request GET \
  --url https://api.vertracloud.app/v1/orders \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vertracloud.app/v1/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vertracloud.app/v1/orders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "response": [
    {
      "id": "order-abc123",
      "status": "paid",
      "price": 24.9,
      "provider": "pix",
      "type": "purchase",
      "related_to": { "plan": { "name": "PRO", "duration": 1, "months": 1 } },
      "created_at": "2026-08-01T12:00:00.000Z",
      "paid_at": "2026-08-01T12:05:00.000Z",
      "has_receipt": true
    }
  ]
}

string

Filters by payment method. Possible values: pix, card, redeem_code.

Response

array

An array of orders, most recent first.

Show Toggle object

string

The order ID.

string

Order status. Possible values: unpaid, paid, cancelled, expired.

number

The final price charged, after any coupon discount.

string

How the order was or will be paid. Possible values: pix, card, redeem_code.

string

What the order is for. Possible values: purchase, renew, upgrade.

The plan the order applies to.

Show Toggle object

object

Show Toggle object

string

The plan name.

integer

Duration in months (1, 3, 6 or 12).

integer

Duration in months (same value as duration).

string

When the order was created.

string | null

When the order was paid, or null if it hasn’t been paid yet.

boolean

Whether a payment receipt exists for this order. Receipts are available in the dashboard billing history.

{
  "response": [
    {
      "id": "order-abc123",
      "status": "paid",
      "price": 24.9,
      "provider": "pix",
      "type": "purchase",
      "related_to": { "plan": { "name": "PRO", "duration": 1, "months": 1 } },
      "created_at": "2026-08-01T12:00:00.000Z",
      "paid_at": "2026-08-01T12:05:00.000Z",
      "has_receipt": true
    }
  ]
}

Error Responses

string

The error code indicating the reason for failure. Possible values:

AUTH_TOKEN_MISSING, API_KEY_INVALID, SESSION_REVOKED: The Authorization header is missing, the API key is invalid, or the dashboard session was revoked (401).
API_KEY_IP_DENIED, API_KEY_SCOPE_DENIED: The API key is used from an IP outside its allowlist, or it lacks the scope the route requires (403).
USER_NOT_FOUND: The authenticated user was not found.
INTERNAL_SERVER_ERROR: An unexpected server error occurred.

{
  "code": "AUTH_TOKEN_MISSING"
}

Last modified on November 1, 2026

List Orders

curl --request GET \
  --url https://api.vertracloud.app/v1/orders \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vertracloud.app/v1/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vertracloud.app/v1/orders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "response": [
    {
      "id": "order-abc123",
      "status": "paid",
      "price": 24.9,
      "provider": "pix",
      "type": "purchase",
      "related_to": { "plan": { "name": "PRO", "duration": 1, "months": 1 } },
      "created_at": "2026-08-01T12:00:00.000Z",
      "paid_at": "2026-08-01T12:05:00.000Z",
      "has_receipt": true
    }
  ]
}

Overview

Endpoints

Response

Error Responses

​Response

​Error Responses

Response

Error Responses