Update payment link

Updates a payment link.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Payment link ID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Name of the payment link.

type?string

Type of payment link.

Value in"subscription"

status?string

Status of the payment link.

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

description?|

Description of the payment link.

plan_id?|

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

slug?string

URL-friendly identifier for the payment link.

Response Body

`application/json`

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

{
  "payment_page": {
    "type": "subscription",
    "id": "paylnk_IhMUl3rrZ3",
    "name": "My Subscription Page",
    "status": "active",
    "description": "A payment link for subscriptions.",
    "slug": "my-subscription-page",
    "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"
  }
}