Sessions

Create a session

POST https://api.piriod.com/customer_base/sessions/

Creates a new Session object.

Request Body

Name	Type	Description
customer	string	ID of related Customer object.
return_url	string	URL to return on session expiration.

201 A newly created Session.

{
    "id": "ses_DyHrsrQjkUSSqYuosg",
    "key": "1d4e158b-1bc3-4a17-896e-be180b8299b4",
    "return_url": "https://dashboard.myproduct.com/",
    "created": "2020-09-01T14:48:30.116162-04:00",
    "customer": "cus_18NSMz56sIVMsXo6Fy",
    "settings": {
        "business_name": "Flintstone App",
        "color_background": "#0066FF",
        "color_asset": "#57698B",
        "display_invoices": true,
        "terms_of_service_url": "",
        "privacy_policy_url": "",
        "return_url": "https://dashboard.myproduct.com/"
    }
}

Retrieve a session

GET https://api.piriod.com/customer_base/sessions/{{key}}/

Retrieves a Session object.

Path Parameters

Name	Type	Description
key	string	key attribute of the Session object.

200 Returns a Session object if a valid session key was provided.

{
    "id": "ses_DyHrsrQjkUSSqYuosg",
    "key": "1d4e158b-1bc3-4a17-896e-be180b8299b4",
    "return_url": "https://dashboard.myproduct.com/",
    "created": "2020-09-01T14:48:30.116162-04:00",
    "customer": "cus_18NSMz56sIVMsXo6Fy",
    "settings": {
        "business_name": "Flintstone App",
        "color_background": "#0066FF",
        "color_asset": "#57698B",
        "display_invoices": true,
        "terms_of_service_url": "",
        "privacy_policy_url": "",
        "return_url": "https://dashboard.myproduct.com/"
    }
}