1. Program
UpPromote Public API
  • API Overview
  • API Changelog
  • Program
    • Get programs
      GET
    • Get a program by ID
      GET
    • Get excluded products/collections of a program
      GET
  • Affiliate
    • Get affiliates
      GET
    • Get affiliate by ID
      GET
    • Create an affiliate
      POST
    • Approve/Deny affiliate
      POST
    • Set upline for an affiliate
      POST
    • Move an affiliate to a program
      POST
    • Connect a customer to an affiliate
      POST
  • Coupon
    • Get coupons
      GET
    • Assign a coupon to an affiliate
      POST
  • Payment
    • Get unpaid payments
      GET
    • Get paid payments (History)
      GET
    • Count total paid payments
      GET
    • Get a payment by ID
      GET
    • Mark as paid a manual payment
      POST
  • Referral
    • Get list referrals
      GET
    • Get a referral by ID
      GET
    • Approve/Deny referral
      POST
    • Create a referral
      POST
    • Add referral adjustment
      POST
  • Webhook
    • Get webhook subscriptions
    • Subscribe a webhook event
    • Update a webhook subscription
    • Delete a webhook subscription
  • Webhook Event Payload
    • Webhook overview
    • Referral new
    • Referral approved
    • Referral denied
    • Referral status changed
    • Affiliate new
    • Affiliate approved
    • Affiliate inactive
    • Affiliate status changed
    • Payment paid
  1. Program

Get a program by ID

GET
/api/v2/programs/{id}

Request

Path Params

Header Params

Responses

🟢200Success
application/json
Body

🟠401Unauthorized
🔴500Server Error
🟠422Parameter Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://aff-api.uppromote.com/api/v2/programs/' \
--header 'Authorization: ****************************' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Response Response Example
200 - Example 1
{
    "status": 200,
    "message": "success",
    "data": {
        "id": 46,
        "name": "Program Test",
        "is_default": "not_default",
        "status": "active",
        "rule": "advance",
        "description": "Description ...",
        "commission_type": "Percent of sale",
        "commission_amount": 20,
        "commission_advanced": [
            {
                "level": 1,
                "condition": "0",
                "commission": "5"
            },
            {
                "level": 2,
                "condition": "3000",
                "commission": "10"
            },
            {
                "level": 3,
                "condition": "5000",
                "commission": "15"
            }
        ],
        "new_customer_commission": null,
        "lifetime_commission": {
            "disconnect_day": 12,
            "first_commission": {
                "type": "Flat rate per item",
                "amount": "6.00"
            }
        },
        "special_coupon_commission": null,
        "exclude_product_tax": true,
        "exclude_shipping": false,
        "exclude_shipping_tax": false,
        "exclude_tip": true,
        "exclude_self_referral": false,
        "payment_methods": [
            "paypal",
            "bank",
            "debit",
            "cheque",
            "store_credit"
        ],
        "payment_default": "debit",
        "created_at": "2021-10-05T04:43:34Z"
    }
}
Modified at 2026-02-23 08:33:49
Previous
Get programs
Next
Get excluded products/collections of a program
Built with