Update payment page

Updates a payment page.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Payment page ID.

Request Body

application/json

name?string

Name of the payment page.

type?string

Type of payment page.

Value in"subscription"

status?string

Status of the payment page.

Value in"draft" | "active" | "archived"

description?string|null

Description of the payment page.

plan_id?string|null

ID of the plan associated with the payment page. Required if type is subscription.

slug?string

URL-friendly identifier for the payment page.

Response Body

`application/json`

curl -X PUT "https://api.sandbox.billingrails.com/v1/payment_pages/paypg_IhMUl3rrZ3" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Subscription Page"
  }'

curl -X PUT "https://api.sandbox.billingrails.com/v1/payment_pages/paypg_IhMUl3rrZ3" \  -H "Content-Type: application/json" \  -d '{    "name": "Updated Subscription Page"  }'

{
  "payment_page": {
    "type": "subscription",
    "id": "paypg_IhMUl3rrZ3",
    "name": "My Subscription Page",
    "status": "active",
    "description": "A payment page for subscriptions.",
    "slug": "my-subscription-page",
    "hosted_url": "https://billingrails.page/acme/pay/my-subscription-page",
    "return_url": null,
    "created_at": "2025-02-14T17:33:40.843Z"
  },
  "meta": {
    "request_id": "req_IhMUl3rrZ3"
  }
}