Get Order Status

GET

orders

{orderId}

status

Get Order Status

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

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

fetch('https://api.vertracloud.app/v1/orders/{orderId}/status', 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/{orderId}/status"

	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": "unpaid",
    "price": 24.9,
    "expires_at": "2026-10-16T12:00:00.000Z",
    "allowed_payment_methods": ["pix"],
    "related_to": { "plan": { "name": "PRO", "months": 1 } }
  }
}

string

required

The order ID.

Response

object

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 | null

When the unpaid order expires, in ISO 8601 (72 hours after the order was created). null when the order has no expiration.

string[]

Payment methods the order accepts (pix, card). A coupon restricted to one method narrows the list.

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).

{
  "response": {
    "id": "order-abc123",
    "status": "unpaid",
    "price": 24.9,
    "expires_at": "2026-10-16T12:00:00.000Z",
    "allowed_payment_methods": ["pix"],
    "related_to": { "plan": { "name": "PRO", "months": 1 } }
  }
}

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.
ORDER_NOT_FOUND: The specified order does not exist.
FORBIDDEN: The order does not belong to the authenticated user.
INTERNAL_SERVER_ERROR: An unexpected server error occurred.

{
  "code": "ORDER_NOT_FOUND"
}

{
  "code": "FORBIDDEN"
}

Last modified on November 1, 2026

Get Order Status

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

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

fetch('https://api.vertracloud.app/v1/orders/{orderId}/status', 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/{orderId}/status"

	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": "unpaid",
    "price": 24.9,
    "expires_at": "2026-10-16T12:00:00.000Z",
    "allowed_payment_methods": ["pix"],
    "related_to": { "plan": { "name": "PRO", "months": 1 } }
  }
}

Overview

Endpoints

Response

Error Responses

​Response

​Error Responses

Response

Error Responses