Skip to main content

Get Subscription Details

GET 
/api/v1/subscriptions/:subscription_id

Get Subscription Details

Request​

Path Parameters

    subscription_id stringrequired

    Splitmo Reference ID of the Subscription

    Example: 4G-SB-AF6A091C

Responses​

Subscription Response

Schema
    oneOf
    customer object
    first_name stringrequired

    Customer's First Name

    last_name stringrequired

    Customer's Last Name

    email emailrequired

    Customer's email

    mobile stringrequired

    Possible values: Value must match regular expression (\+63|0)?([.\- ]?9[0-9]{2}[.\- ]?[0-9]{3}[.\- ]?[0-9]{4})

    Customer's mobile number

    billing_details object

    Merchant can pre-fill customer's billing details. If not supplied, customer will be asked to fill up billing details during Splitmo checkout.

    full_address stringrequired
    city stringrequired
    zip_code stringrequired
    region stringrequired
    country_code stringrequired

    Default value: PH

    redirect_urls object

    Merchant can supply a redirect URL after a successful or failed transaction.

    success_url urlrequired
    failure_url urlrequired
    cancel_url urlrequired
    plan objectnullable

    Subscription Plan Details

    plan_name string
    price double
    billing_cycle string

    Possible values: [MO, WE, BI]

    short_lead string
    company string
    reference_id string
    checkout_url url
    payment_method
    status string

    Possible values: [INITIATED, FOR_VERIFICATION, FOR_AUTHENTICATION, SUCCESSFUL, FAILED TO CAPTURE, FAILED TO AUTHORIZE, CANCELLED, REFUNDED]

Loading...