npm package: @one-view/pd-oneview-membership-types
Description: membership plugin for displaying information related to customer membership
Latest version: 0.0.14


FORMAT: 1A
HOST: https://api.pd-oneview.net/membership

# pd-oneview-membership

membership plugin for displaying information related to customer membership




## Info [/v1/customers/{customerId}/info{?geid,nocache}]

Membership information

+ Parameters
    + customerId (required, string, `vsba-nhas`)
    + geid (required, string, `FP_SG`)
    + nocache (boolean, optional, `false`) - bypass the cache when calling GCC order endpoint

+ Attributes (CustomerSubscriptionList)

### Get membership information [GET]

+ Request

    + Headers

            Authorization: bearer token
            X-Contact-Id: case-id

+ Response 200 (application/json)
    + Attributes (CustomerSubscriptionList)

+ Response 400 (application/json)
    + Attributes (Error)

+ Response 403 (application/json)
    + Attributes (Error)

+ Response 404 (application/json)
    + Attributes (Error)

+ Response 500 (application/json)
    + Attributes (Error)
# Data Structures

## int64 (number)

## `error_object` (object)
+ status (string)
+ title (string)

## `Error` (object)
+ errors (array[error_object], fixed-type)

### CustomerSubscriptionList

+ subscriptions (array, fixed-type, optional)
    + (CustomerSubscription)

### CustomerSubscription 

+ subscription_id: asdfg12345 (required)
+ customer_id (required)
    + Sample: 12344
+ global_entity_id (required)
+ plan_id (required)
    + Sample: 345
+ subscription_status (CustomerSubscriptionStatus, required)
+ benefits (CustomerSubscriptionBenefits, required)
+ subscription_period_start_timestamp: 2020-04-08T10:43:17.000Z (required)
+ subscription_period_end_timestamp: 2020-04-08T10:43:17.000Z (required)
+ last_payment_reference: midas (optional)
+ subscription_creation_timestamp: 2020-04-08T10:43:17.000Z (required)
+ timestamp: 2020-04-08T10:43:17.000Z (required)

### CustomerSubscriptionStatus (enum)
+ subscription_requested
+ payment_requested
+ payment_failed
+ enabled
+ renewal_requested
+ cancelled

### CustomerSubscriptionBenefits 

+ free_delivery (FreeDeliveryBenefit, optional)
+ customer_incentives (array[CustomerIncentives], fixed-type, optional)
+ dine_in (DineInBenefit, optional)

### FreeDeliveryBenefit 

+ is_unlimited: true (boolean, required)
+ max_count: 10 (number, required)
+ used_count: 3 (number, required)
+ remaining_count: 7 (number, required)

### CustomerIncentives 

+ incentive_category: discount (required)
+ is_stackable: true (boolean, required)
+ is_recurring: true (boolean, required)
+ incentive_type (CustomerIncentiveType, required)
+ amount: 12.3 (number, required)
+ percentage: 1.2 (number, required)
+ quantity: 2.5 (number, required)
+ rules (IncentiveRules, optional)

### DineInBenefit 

+ max: 2.5 (number, required)
+ is_unlimited: true (boolean, required)
+ max_per_vendor: 10.2 (number, required)
+ max_per_period: 34.3 (number, required)
+ limit_period_in_hours: 12.5 (number, required)
+ max_per_vendor_period: 12.5 (number, required)
+ limit_vendor_period_in_hours: 4.5 (number, required)

### CustomerIncentiveType (enum)
+ amount
+ percentage
+ delivery_fee
+ free_gift
+ bxgy

### IncentiveRules 

+ max_incentive: 30.99 (number, required)
+ min_order_amount: 10.99 (number, required)
+ delivery_types (array[string], fixed-type, optional)
    + Sample: delivery,pickup
+ parent_vertical: restaurants (required)
+ vertical_types (array[string], fixed-type, optional)
    + Sample: restaurants,shops
+ timing (Timing, optional)

### Timing 

+ start_date: 2021-03-01T00:00:00.000Z (optional)
+ end_date: 2021-03-01T00:00:00.000Z (optional)