Skip to main content
GET
/
api
/
v1
/
subscriptions
/
{subscription_id}
Get Subscription
curl --request GET \
  --url http://localhost:8000/api/v1/subscriptions/{subscription_id} \
  --header 'Authorization: Bearer <token>'
{
  "google_ads_customer_id": 123,
  "subscription_plan_id": 123,
  "starts_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "subscription_type": "auto_renew",
  "id": 123,
  "date_added": "2023-11-07T05:31:56Z",
  "date_updated": "2023-11-07T05:31:56Z",
  "subscription_plan": {
    "name": "<string>",
    "price": "<string>",
    "id": 123,
    "date_added": "2023-11-07T05:31:56Z",
    "date_updated": "2023-11-07T05:31:56Z",
    "image_url": "<string>",
    "modules": [
      {
        "analysis_type": "keyword_pause",
        "constraint": 123,
        "analysis_frequency_hours": 123,
        "id": 123,
        "date_added": "2023-11-07T05:31:56Z",
        "date_updated": "2023-11-07T05:31:56Z",
        "is_autopilot_enabled": false
      }
    ]
  },
  "cancelled_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

subscription_id
integer
required

Response

Successful Response

Schema for reading Subscription with plan and customer details.

google_ads_customer_id
integer
required
subscription_plan_id
integer
required
starts_at
string<date-time>
required
expires_at
string<date-time>
required
subscription_type
enum<string>
required
Available options:
auto_renew,
one_time
id
integer
required
date_added
string<date-time>
required
date_updated
string<date-time>
required
subscription_plan
SubscriptionPlanWithModulesSchema · object
required

Schema for reading SubscriptionPlan with modules.

cancelled_at
string<date-time> | null