Export Subscriptions

GET

subscriptions

export

Python

from ourpay.v2026_10 import OurPay

ourpay = OurPay("ourpay_oat_xxx")

response = ourpay.subscriptions.export(
    timezone='UTC',
)
print(response)

import { createOurPay } from "@ourpay-dev/sdk/2026-10";

const ourpay = createOurPay({
  accessToken: "ourpay_oat_xxx",
});

const response = await ourpay.subscriptions.export(
  {
    "timezone": "UTC"
  },
);
console.log(response);

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

fetch('https://api.ourpay.dev/v1/subscriptions/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ourpay.dev/v1/subscriptions/export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.ourpay.dev/v1/subscriptions/export"

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

}

require 'uri'
require 'net/http'

url = URI("https://api.ourpay.dev/v1/subscriptions/export")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

"<string>"

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

You can generate a Personal Access Token from your settings.

Query Parameters

organization_id

Filter by organization ID. The organization ID.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

product_id

Filter by product ID. The product ID.

status

Filter by subscription status.

Available options:

incomplete,

incomplete_expired,

trialing,

active,

past_due,

canceled,

unpaid,

paused

cancel_at_period_end

boolean | null

Filter by subscriptions that are set to cancel at period end.

started_after

string<date-time> | null

Only include subscriptions started after this date. Must include a UTC offset.

started_before

string<date-time> | null

Only include subscriptions started before this date. Must include a UTC offset.

timezone

string

default:UTC

Time zone used to render dates in the CSV.

columns

Columns to include in the CSV, in order. Defaults to email, started_at, product, amount, currency, status and recurring_interval.

Available options:

email,

started_at,

product,

amount,

currency,

status,

recurring_interval,

customer_name,

billing_name,

billing_country,

net_amount,

discount,

seats,

current_period_start,

current_period_end,

cancel_at_period_end,

canceled_at,

ends_at,

ended_at,

cancellation_reason,

trial_start,

trial_end

Response

Successful Response

The response is of type string.

Python

from ourpay.v2026_10 import OurPay

ourpay = OurPay("ourpay_oat_xxx")

response = ourpay.subscriptions.export(
    timezone='UTC',
)
print(response)

import { createOurPay } from "@ourpay-dev/sdk/2026-10";

const ourpay = createOurPay({
  accessToken: "ourpay_oat_xxx",
});

const response = await ourpay.subscriptions.export(
  {
    "timezone": "UTC"
  },
);
console.log(response);

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

fetch('https://api.ourpay.dev/v1/subscriptions/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ourpay.dev/v1/subscriptions/export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.ourpay.dev/v1/subscriptions/export"

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

}

require 'uri'
require 'net/http'

url = URI("https://api.ourpay.dev/v1/subscriptions/export")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

"<string>"

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

General

Endpoints

Export Subscriptions

Authorizations

Query Parameters

Response