v1
latestOpenAPI 3.1.02026-07-24233206489.1 KBHosted Invoice Page
Attach a checkout session by hosted slug (public)
Sets the checkout session ID on the invoice with the given hosted slug (used by the hosted page when the customer starts payment). Returns the same customer-facing payload as the by-slug retrieve.
patch/v1/invoices/by_slug/{slug}
Path parameters
slugstring required
Hosted invoice slug
Request body
Example request
{
"checkout_session_id": "cs_abc123"
}Response
OK
Example response
{
"data": {
"accent_color": "#0C2F28",
"amount_due": 145000,
"checkout_session_id": "cs_abc123",
"created_at": "2026-07-08 08:00:00+00:00",
"currency": "PHP",
"customer_email": "juan@example.com",
"customer_id": "cus_abc123",
"customer_name": "Juan dela Cruz",
"customer_phone": "+639171234567",
"customer_tin": "123-456-789-000",
"discount": 5000,
"due_at": "2026-07-22 00:00:00+00:00",
"footer_bg_color": "#FFFDF6",
"footer_image_url": "https://example.com/footer.png",
"header_bg_color": "#0C2F28",
"header_image_url": "https://example.com/header.png",
"hosted_slug": "inv-8f2k1x",
"hosted_url": "https://invoices.paymongo.com/inv/inv-8f2k1x",
"id": "si_abc123",
"internal_notes": "Net-14 terms agreed with the client",
"issue_at": "2026-07-08 00:00:00+00:00",
"line_items": [
{
"amount": 75000,
"description": "Website design services",
"id": "sili_abc123",
"line_total": 150000,
"quantity": 2
}
],
"logo_url": "https://example.com/logo.png",
"merchant_name": "Acme Studio PH",
"notes": "Thank you for your business!",
"number": "INV-0001",
"organization_id": "org_abc123",
"paid_at": "2026-07-10 08:30:00+00:00",
"payment_methods": [
"card",
"gcash"
],
"reminders_enabled": true,
"sent_at": "2026-07-08 09:00:00+00:00",
"subtotal": 150000,
"total": 145000,
"updated_at": "2026-07-08 09:00:00+00:00"
}
}