Skip to content
This repository has been archived by the owner on Oct 30, 2023. It is now read-only.

API List

Jump to bottom
Zalasanjay edited this page Jun 8, 2018 · 5 revisions

Plans

https://api.flowzdigital.com/subscription/cb-plan { headers: authorization }

  • GET

    • Response

      [{"plan":{"id":"cbdemo_hustle","name":"Hustle","invoice_name":"Plan - Hustle","description":"This plan has a 14-day trial period.","price":4900,"period":1,"period_unit":"month","trial_period":14,"trial_period_unit":"day","charge_model":"flat_fee","free_quantity":0,"status":"archived","archived_at":1527763527,"enabled_in_hosted_pages":true,"enabled_in_portal":true,"updated_at":1527763527,"resource_version":1527763527750,"object":"plan","taxable":true,"currency_code":"USD"}}]

  • POST

    • Request

      {“id”: “41841a**-b8af-42**-b07a-dfd309d5a1b4”, “name”: “Full Plan”, “invoice_name”: “Full_name”, “description”: “Plan description”, “period” : “1”,“period_unit”: “month”, // week, month, year “trial_period”: “1”,“trial_period_unit”: “day”, “price”: “99900”, // in cents “meta_data”: JSON Object}

    • Response

      {"id":"11****40-6a1b-18-a0a5-0f9***c03b","name":"Base Plan","invoice_name":"Base Plan","description":"Website Builder\n1 eCommerce Site\nNo Virtual & CRM","price":99900,"period":1,"period_unit":"month","charge_model":"flat_fee","free_quantity":0,"status":"archived","enabled_in_hosted_pages":true,"enabled_in_portal":true,"updated_at":1528352512,"resource_version":1528352512931,"object":"plan","taxable":true,"currency_code":"USD","meta_data":{"details": array_of_object}}

  • PUT

    • Request { params: plan_id }

      {"name":"Base Plan","description":"Website Builder\n1 eCommerce Site\nNo Virtual & CRM","invoice_name":"Base Plan","period":1,"price":99900,"meta_data":{"details":[{"module":"crm","service":"settings","action":"create","value":0},{"module":"webbuilder","service":"delete-service","action":"remove","value":0}]}}

  • PATCH (Use to unarchive plan)

    • Request { params: plan_id }

  • DELETE (Use to delete or archive plan)

    • Request { params: plan_id }

Addon

https://api.flowzdigital.com/subscription/cb-addon { headers: authorization }

  • GET

    • Response

      [{"addon":{"id":"3b036d70-64c7-11e8-8ebb-1365474b7ffa","name":"Extra Uploader","invoice_name":"Extra Uploader","description":"Website Builder\n1 eCommerce Site\nNo Virtual & CRM","type":"on_off","charge_type":"recurring","price":0,"period":1,"period_unit":"month","status":"active","enabled_in_portal":true,"updated_at":1527775211,"resource_version":1527775211209,"object":"addon","currency_code":"USD","taxable":true,"meta_data":{"details":[{"module":"crm","service":"settings","action":"create","value":0},{"module":"webbuilder","service":"delete-service","action":"remove","value":0},{"module":"webbuilder","service":"subscription-websites","action":"find","value":0}]}}}]

  • POST

    • Request

      {"id":"55dcfcb0-6a3f-11e8-a0a5-0f90cf20c03b","name":"Addon","description":"Website Builder\n1 eCommerce Site\nNo Virtual & CRM","invoice_name":"Addon","price":99900,"status":"archived","period":1,"period_unit":"month","meta_data":{"details":[{"module":"crm","service":"settings","action":"create","value":0},{"module":"webbuilder","service":"delete-service","action":"remove","value":0},{"module":"webbuilder","service":"subscription-websites","action":"find","value":0}]},"type":"on_off","charge_type":"recurring"}

  • PUT

    • Request { params: addon_id }

      {"name":"Addon","invoice_name":"Addon","price":99900,"period":1,"meta_data":{"details":[{"module":"crm","service":"settings","action":"create","value":0},{"module":"webbuilder","service":"delete-service","action":"remove","value":0},{"module":"webbuilder","service":"subscription-websites","action":"find","value":0},{"module":"webbuilder","service":"subscription-websites","action":"get","value":0}]}}

  • PATCH (Use to unarchive addon)

    • Request { params: addon_id }

  • DELETE (Use to delete or archive addon)

    • Request { params: addon_id }

Register-resource

https://api.flowzdigital.com/subscription/register-resource { headers: authorization }

  • GET
    • Response

      {"total":3,"data":[{"actions":[{"create":"create"}],"id":"37d9750d-13c1-4274-bb5e-eef2e3e8ffc4","module":"crm","service":"settings"},{"actions":[{"remove":"remove"}],"id":"33821276-a682-40a6-b1f3-933eac3c1725","module":"webbuilder","service":"delete-service"},{"actions":[{"find":"find","get":"get"}],"id":"e3556c5f-02e3-44db-9d99-2f3eaeb61ae2","module":"webbuilder","service":"subscription-websites"}],"limit":1000,"skip":0}

Subscription

https://api.flowzdigital.com/subscription/cb-subscription { headers: authorization }

  • GET
    • Response {query_string_params: customer_id, limit}

      [{"subscription":{"id":"1mkVvobQuvKrJq","customer_id":"5a8ec4851b57a056","plan_id":"ec6e45**-**20-4a4b-bf00-86deb3f0c89c","plan_quantity":1,"plan_unit_price":99900,"billing_period":12,"billing_period_unit":"month"},"customer":{"id":"5a8ec480012556","first_name":"Ekta","last_name":"Chadha","email":"[email protected]","auto_collection":"on","payment_method":{"object":"payment_method","type":"card","reference_id":"cus_CzEw3HHvXzmWE7NQT","gateway":"stripe","status":"valid"},"promotional_credits":0,"refundable_credits":0,"excess_payments":0,"unbilled_charges":0,"preferred_currency_code":"USD"},"card":{"status":"valid","gateway":"stripe","iin":"4242","last4":"42**","card_type":"**sa","funding_type":"credit","expiry_month":2,"expiry_year":2021,"issuing_country":"US","object":"card","masked_number":"***4242","customer_id":"5a8ec4855001257a056","payment_source_id":"pm_2c9CqQuBREsF"}}]

Customer

https://api.flowzdigital.com/subscription/cb-customer { headers: authorization }

  • GET
    • Response { params: customer_id }

      {"customer":{"id":"5ae003a52971","first_name":"Faizan","last_name":"Saiyed","email":"fsa**[email protected]","auto_collection":"on","net_term_days":0,"allow_direct_debit":false,"created_at":1528352911,"taxability":"taxable","updated_at":1528352912,"resource_version":18329140,"deleted":false,"object":"customer","card_status":"valid","primary_payment_source_id":"pm_2smo**GTKVo2","payment_method":{"object":"payment_method","type":"card","reference_id":"cus_D0IC7hat2K/card_1aHIJPvXzm3FZKszsxV","gateway":"stripe","status":"valid"},"promotional_credits":0,"refundable_credits":0,"excess_payments":0,"unbilled_charges":0,"preferred_currency_code":"USD"},"card":{"status":"valid","gateway":"stripe","iin":"424242","last4":"4242","card_type":"visa","funding_type":"credit","expiry_month":2,"expiry_year":2020,"issuing_country":"US","object":"card","masked_number":"************4242"}}

User Subscription

https://api.flowzdigital.com/subscription/user-subscription { headers: authorization }

  • GET
    • Response

      { "createdAt": "2018-06-07T06:28:33.978Z", "details": { "crm": { "contacts": { "create": 0, "find": 0, "get": 0, "remove": 0, "update": 0 }, "settings": { "create": 0 } }, "uploader": { "uploader": { "create": 1 } }, "webbuilder": { "address-book": { "create": 0, "find": 0, "get": 0, "patch": 0 }, "delete-service": { "remove": 1 } } }, "expiredOn": "2019-06-07T06:28:31+00:00", "id": "dfcde232-e5e9-4a7a-8072-b9c82f523527", "name": "Premium Plus", "plan_id": "ec6e4556-1520-4a4b-bf00-86deb3f0c89c", "price": 999, "sub_id": "5ae00ccca93fff0013a52971", "time_unit": "month", "trans_id": [ { "applied_amount": 99900, "applied_at": 1528352913, "txn_amount": 99900, "txn_date": 1528352913, "txn_id": "txn_2smoc98OQuGT4DBVo5", "txn_status": "success" } ], "userId": "5ae00ccca93fff0013a52971", "validity": 12 }

Clone this wiki locally