Skip to main content
Skip to navigation
API docs by Redocly

Developer API (2.0.0)

Download OpenAPI specification:Download

Subscription Transactions

Part of the REST API v2 Reference.

Operations about subscription transactions.

Endpoints

Get a Play Store or App Store subscription's transactions

This endpoint requires the following permission(s): customer_information:subscriptions:read. This endpoint belongs to the Customer Information domain, which has a default rate limit of 480 requests per minute.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

subscription_id
required
string [ 1 .. 255 ] characters
Example: sub1a2b3c4d5e

ID of the subscription

query Parameters
starting_after
string
Example: starting_after=ent12354

Pagination cursor. Pass the id of the last item from the previous page to fetch the next page; omit for the first page.

limit
integer
Default: 20
Example: limit=10

Maximum number of items to return per page. Values below 1 or above 100 are clamped to that range rather than rejected.

sort
string
Default: "id"
Enum: "id" "purchased_at"
Example: sort=purchased_at

Column to sort the result list by.

direction
string
Default: "asc"
Enum: "asc" "desc"
Example: direction=desc

Sort direction for the result list.

Responses

Response samples

Content type
application/json
{
  • "object": "list",
  • "items": [
    ],
  • "next_page": "/v2/projects/proj123/subscriptions/sub123/transactions?starting_after=GPA.0000-0000-0000-00000",
  • "url": "/v2/projects/proj123/subscriptions/sub123/transactions"
}

Refund a Play Store or Galaxy subscription's transaction

Refund and cancel a Play Store or Galaxy subscription's transaction. Access to the subscription will be revoked. This endpoint requires the following permission(s): customer_information:subscriptions:read_write. This endpoint belongs to the Subscription Transactions Refunds domain, which has a default rate limit of 480 requests per minute.

Authorizations:
BearerAuth
path Parameters
project_id
required
string <= 255 characters
Example: proj1ab2c3d4

ID of the project

subscription_id
required
string [ 1 .. 255 ] characters
Example: sub1a2b3c4d5e

ID of the subscription

transaction_id
required
string [ 1 .. 255 ] characters
Example: GPA.000-000-000-000

Identifier of the transaction in the store

Responses

Response samples

Content type
application/json
{
  • "object": "subscription_transaction",
  • "id": "GPA.0000-0000-0000-00000",
  • "purchased_at": 1658399423658,
  • "product_store_identifier": "com.example.product",
  • "revenue_in_local_currency": {
    },
  • "revenue_in_usd": {
    },
  • "expiration_date": 1658399423658,
  • "effective_expiration_date": 1658399423658
}

Endpoint Reference

All API v2 resources, one page each. General concepts (authentication, pagination, rate limits, error handling) live on the API v2 overview.