RevenueCat Integration

Field	Description	Required	Format
RevenueCat API Key	Your RevenueCat REST API v1 key (secret key recommended)	Yes	`sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`

get_customer — Retrieve subscriber information by app user ID.

Parameters

string

required

The app user ID of the subscriber

Response

{
  "$defs": {
    "Subscriber": {
      "additionalProperties": false,
      "description": "A RevenueCat subscriber object.\n\n``subscriptions`` and ``entitlements`` are maps keyed by product /\nentitlement identifier; their values are left as opaque dicts so the\nupstream shape is preserved verbatim.",
      "properties": {
        "first_seen": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "First Seen"
        },
        "last_seen": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Last Seen"
        },
        "original_app_user_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Original App User Id"
        },
        "original_application_version": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Original Application Version"
        },
        "original_purchase_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Original Purchase Date"
        },
        "management_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Management Url"
        },
        "subscriptions": {
          "additionalProperties": true,
          "title": "Subscriptions",
          "type": "object"
        },
        "entitlements": {
          "additionalProperties": true,
          "title": "Entitlements",
          "type": "object"
        },
        "non_subscriptions": {
          "additionalProperties": true,
          "title": "Non Subscriptions",
          "type": "object"
        },
        "other_purchases": {
          "additionalProperties": true,
          "title": "Other Purchases",
          "type": "object"
        },
        "subscriber_attributes": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Subscriber Attributes"
        }
      },
      "title": "Subscriber",
      "type": "object"
    },
    "SubscriberMetadata": {
      "additionalProperties": false,
      "description": "Summary metadata derived from a subscriber payload.",
      "properties": {
        "app_user_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "App User Id"
        },
        "first_seen": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "First Seen"
        },
        "active_entitlements": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Active Entitlements"
        },
        "active_subscriptions": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Active Subscriptions"
        }
      },
      "title": "SubscriberMetadata",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "subscriber": {
      "anyOf": [
        {
          "$ref": "#/$defs/Subscriber"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "metadata": {
      "anyOf": [
        {
          "$ref": "#/$defs/SubscriberMetadata"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "GetCustomerOutput",
  "type": "object"
}

delete_customer — Permanently delete a subscriber and all associated data.

Parameters

string

required

The app user ID of the subscriber to delete

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "deleted": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Deleted"
    },
    "app_user_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "App User Id"
    }
  },
  "required": [
    "success"
  ],
  "title": "DeleteCustomerOutput",
  "type": "object"
}

create_purchase — Record a purchase (receipt) for a subscriber via the REST API.

Parameters

string

required

The app user ID of the subscriber

string

required

Store receipt or purchase token: iOS base64 receipt / JWSTransaction, Android purchase token, Amazon receipt, Stripe subscription or Checkout Session ID, Roku transaction ID, or Paddle subscription/transaction ID

string

required

Platform of the purchase, sent as the X-Platform header. One of: ios, android, amazon, macos, uikitformac, stripe, roku, paddle

string

Product identifier or SKU. Required for Google.

number

Price of the product. Required if you provide a currency.

string

ISO 4217 currency code. Required if you provide a price.

boolean

Deprecated. Triggers configured restore behavior for shared fetch tokens.

string

Identifier of the offering presented to the customer at purchase time.

string

Payment mode for the introductory period: pay_as_you_go, pay_up_front, or free_trial.

number

Introductory price paid (if any).

string

JSON object of subscriber attributes to set alongside the purchase. Each key maps to {“value”: string, “updated_at_ms”: number}.

integer

UNIX epoch ms used to resolve attribute conflicts at the request level.

Response

{
  "$defs": {
    "Subscriber": {
      "additionalProperties": false,
      "description": "A RevenueCat subscriber object.\n\n``subscriptions`` and ``entitlements`` are maps keyed by product /\nentitlement identifier; their values are left as opaque dicts so the\nupstream shape is preserved verbatim.",
      "properties": {
        "first_seen": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "First Seen"
        },
        "last_seen": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Last Seen"
        },
        "original_app_user_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Original App User Id"
        },
        "original_application_version": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Original Application Version"
        },
        "original_purchase_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Original Purchase Date"
        },
        "management_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Management Url"
        },
        "subscriptions": {
          "additionalProperties": true,
          "title": "Subscriptions",
          "type": "object"
        },
        "entitlements": {
          "additionalProperties": true,
          "title": "Entitlements",
          "type": "object"
        },
        "non_subscriptions": {
          "additionalProperties": true,
          "title": "Non Subscriptions",
          "type": "object"
        },
        "other_purchases": {
          "additionalProperties": true,
          "title": "Other Purchases",
          "type": "object"
        },
        "subscriber_attributes": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Subscriber Attributes"
        }
      },
      "title": "Subscriber",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "customer": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Customer"
    },
    "subscriber": {
      "anyOf": [
        {
          "$ref": "#/$defs/Subscriber"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "CreatePurchaseOutput",
  "type": "object"
}

grant_entitlement — Grant a promotional entitlement to a subscriber.

Parameters

string

required

The app user ID of the subscriber

string

required

The entitlement identifier to grant

string

Deprecated. Provide either duration or end_time_ms (end_time_ms preferred). One of: daily, three_day, weekly, two_week, monthly, two_month, three_month, six_month, yearly, lifetime.

integer

Absolute end time in ms since Unix epoch. Use instead of duration.

integer

Deprecated. Optional start time in ms since Unix epoch, used with duration.

Response

{
  "$defs": {
    "Subscriber": {
      "additionalProperties": false,
      "description": "A RevenueCat subscriber object.\n\n``subscriptions`` and ``entitlements`` are maps keyed by product /\nentitlement identifier; their values are left as opaque dicts so the\nupstream shape is preserved verbatim.",
      "properties": {
        "first_seen": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "First Seen"
        },
        "last_seen": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Last Seen"
        },
        "original_app_user_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Original App User Id"
        },
        "original_application_version": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Original Application Version"
        },
        "original_purchase_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Original Purchase Date"
        },
        "management_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Management Url"
        },
        "subscriptions": {
          "additionalProperties": true,
          "title": "Subscriptions",
          "type": "object"
        },
        "entitlements": {
          "additionalProperties": true,
          "title": "Entitlements",
          "type": "object"
        },
        "non_subscriptions": {
          "additionalProperties": true,
          "title": "Non Subscriptions",
          "type": "object"
        },
        "other_purchases": {
          "additionalProperties": true,
          "title": "Other Purchases",
          "type": "object"
        },
        "subscriber_attributes": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Subscriber Attributes"
        }
      },
      "title": "Subscriber",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "subscriber": {
      "anyOf": [
        {
          "$ref": "#/$defs/Subscriber"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "GrantEntitlementOutput",
  "type": "object"
}

revoke_entitlement — Revoke all promotional entitlements for a specific entitlement identifier.

Parameters

string

required

The app user ID of the subscriber

string

required

The entitlement identifier to revoke

Response

{
  "$defs": {
    "Subscriber": {
      "additionalProperties": false,
      "description": "A RevenueCat subscriber object.\n\n``subscriptions`` and ``entitlements`` are maps keyed by product /\nentitlement identifier; their values are left as opaque dicts so the\nupstream shape is preserved verbatim.",
      "properties": {
        "first_seen": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "First Seen"
        },
        "last_seen": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Last Seen"
        },
        "original_app_user_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Original App User Id"
        },
        "original_application_version": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Original Application Version"
        },
        "original_purchase_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Original Purchase Date"
        },
        "management_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Management Url"
        },
        "subscriptions": {
          "additionalProperties": true,
          "title": "Subscriptions",
          "type": "object"
        },
        "entitlements": {
          "additionalProperties": true,
          "title": "Entitlements",
          "type": "object"
        },
        "non_subscriptions": {
          "additionalProperties": true,
          "title": "Non Subscriptions",
          "type": "object"
        },
        "other_purchases": {
          "additionalProperties": true,
          "title": "Other Purchases",
          "type": "object"
        },
        "subscriber_attributes": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Subscriber Attributes"
        }
      },
      "title": "Subscriber",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "subscriber": {
      "anyOf": [
        {
          "$ref": "#/$defs/Subscriber"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "RevokeEntitlementOutput",
  "type": "object"
}

list_offerings — List all offerings configured for the project.

Parameters

string

required

An app user ID to retrieve offerings for

string

X-Platform header value. One of: ios, android, amazon, stripe, roku, paddle. Required for legacy public API keys; ignored with app-specific keys.

Response

{
  "$defs": {
    "Offering": {
      "additionalProperties": false,
      "description": "A single offering configured for the project.",
      "properties": {
        "identifier": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Identifier"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Description"
        },
        "packages": {
          "items": {
            "$ref": "#/$defs/OfferingPackage"
          },
          "title": "Packages",
          "type": "array"
        }
      },
      "title": "Offering",
      "type": "object"
    },
    "OfferingPackage": {
      "additionalProperties": false,
      "description": "A single package inside an offering.",
      "properties": {
        "identifier": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Identifier"
        },
        "platform_product_identifier": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Platform Product Identifier"
        }
      },
      "title": "OfferingPackage",
      "type": "object"
    },
    "OfferingsMetadata": {
      "additionalProperties": false,
      "description": "Summary metadata for a list-offerings response.",
      "properties": {
        "count": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Count"
        },
        "current_offering_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Current Offering Id"
        }
      },
      "title": "OfferingsMetadata",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "current_offering_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Current Offering Id"
    },
    "offerings": {
      "items": {
        "$ref": "#/$defs/Offering"
      },
      "title": "Offerings",
      "type": "array"
    },
    "metadata": {
      "anyOf": [
        {
          "$ref": "#/$defs/OfferingsMetadata"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "ListOfferingsOutput",
  "type": "object"
}

update_subscriber_attributes — Update custom subscriber attributes (e.g., $email, $displayName, or custom key-value pairs).

Parameters

string

required

The app user ID of the subscriber

string

required

JSON object of attributes to set. Each key maps to an object with “value” (string; null or empty deletes the attribute) and “updated_at_ms” (Unix epoch ms used for conflict resolution — required).

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "updated": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Updated"
    },
    "app_user_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "App User Id"
    }
  },
  "required": [
    "success"
  ],
  "title": "UpdateSubscriberAttributesOutput",
  "type": "object"
}

defer_google_subscription — Defer a Google Play subscription by extending its billing date (Google Play only).

Parameters

string

required

The app user ID of the subscriber

string

required

The Google Play product identifier of the subscription to defer

integer

Number of days to extend by (1-365). Provide extend_by_days or expiry_time_ms.

integer

Absolute new expiry time in ms since Unix epoch. Use instead of extend_by_days.

Response

{
  "$defs": {
    "Subscriber": {
      "additionalProperties": false,
      "description": "A RevenueCat subscriber object.\n\n``subscriptions`` and ``entitlements`` are maps keyed by product /\nentitlement identifier; their values are left as opaque dicts so the\nupstream shape is preserved verbatim.",
      "properties": {
        "first_seen": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "First Seen"
        },
        "last_seen": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Last Seen"
        },
        "original_app_user_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Original App User Id"
        },
        "original_application_version": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Original Application Version"
        },
        "original_purchase_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Original Purchase Date"
        },
        "management_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Management Url"
        },
        "subscriptions": {
          "additionalProperties": true,
          "title": "Subscriptions",
          "type": "object"
        },
        "entitlements": {
          "additionalProperties": true,
          "title": "Entitlements",
          "type": "object"
        },
        "non_subscriptions": {
          "additionalProperties": true,
          "title": "Non Subscriptions",
          "type": "object"
        },
        "other_purchases": {
          "additionalProperties": true,
          "title": "Other Purchases",
          "type": "object"
        },
        "subscriber_attributes": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Subscriber Attributes"
        }
      },
      "title": "Subscriber",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "subscriber": {
      "anyOf": [
        {
          "$ref": "#/$defs/Subscriber"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "DeferGoogleSubscriptionOutput",
  "type": "object"
}

refund_google_subscription — Refund a specific store transaction by its store transaction identifier and revoke access (subscription or non-subscription, last 365 days).

Parameters

string

required

The app user ID of the subscriber

string

required

The store transaction identifier of the purchase to refund (e.g., GPA.3309-9122-6177-45730 for Google Play)

Response

{
  "$defs": {
    "Subscriber": {
      "additionalProperties": false,
      "description": "A RevenueCat subscriber object.\n\n``subscriptions`` and ``entitlements`` are maps keyed by product /\nentitlement identifier; their values are left as opaque dicts so the\nupstream shape is preserved verbatim.",
      "properties": {
        "first_seen": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "First Seen"
        },
        "last_seen": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Last Seen"
        },
        "original_app_user_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Original App User Id"
        },
        "original_application_version": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Original Application Version"
        },
        "original_purchase_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Original Purchase Date"
        },
        "management_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Management Url"
        },
        "subscriptions": {
          "additionalProperties": true,
          "title": "Subscriptions",
          "type": "object"
        },
        "entitlements": {
          "additionalProperties": true,
          "title": "Entitlements",
          "type": "object"
        },
        "non_subscriptions": {
          "additionalProperties": true,
          "title": "Non Subscriptions",
          "type": "object"
        },
        "other_purchases": {
          "additionalProperties": true,
          "title": "Other Purchases",
          "type": "object"
        },
        "subscriber_attributes": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Subscriber Attributes"
        }
      },
      "title": "Subscriber",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "subscriber": {
      "anyOf": [
        {
          "$ref": "#/$defs/Subscriber"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "RefundGoogleSubscriptionOutput",
  "type": "object"
}

revoke_google_subscription — Immediately revoke access to a Google Play subscription and issue a refund (Google Play only).

Parameters

string

required

The app user ID of the subscriber

string

required

The Google Play product identifier of the subscription to revoke

Response

{
  "$defs": {
    "Subscriber": {
      "additionalProperties": false,
      "description": "A RevenueCat subscriber object.\n\n``subscriptions`` and ``entitlements`` are maps keyed by product /\nentitlement identifier; their values are left as opaque dicts so the\nupstream shape is preserved verbatim.",
      "properties": {
        "first_seen": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "First Seen"
        },
        "last_seen": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Last Seen"
        },
        "original_app_user_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Original App User Id"
        },
        "original_application_version": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Original Application Version"
        },
        "original_purchase_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Original Purchase Date"
        },
        "management_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Management Url"
        },
        "subscriptions": {
          "additionalProperties": true,
          "title": "Subscriptions",
          "type": "object"
        },
        "entitlements": {
          "additionalProperties": true,
          "title": "Entitlements",
          "type": "object"
        },
        "non_subscriptions": {
          "additionalProperties": true,
          "title": "Non Subscriptions",
          "type": "object"
        },
        "other_purchases": {
          "additionalProperties": true,
          "title": "Other Purchases",
          "type": "object"
        },
        "subscriber_attributes": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Subscriber Attributes"
        }
      },
      "title": "Subscriber",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "subscriber": {
      "anyOf": [
        {
          "$ref": "#/$defs/Subscriber"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "RevokeGoogleSubscriptionOutput",
  "type": "object"
}

Using

Providers

Building

Tools

RevenueCat Integration for AI Agents & Workflows

Overview

Authentication

API Key Authentication

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Lemon Squeezy

Stripe

Square

Links

​Overview

​Authentication

​API Key Authentication

​Required Credentials

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Limits & Quotas

​Related integrations

Lemon Squeezy

Stripe

Square

​Links

Overview

Authentication

API Key Authentication

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Related integrations

Links