-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
In the Messaging API, you can now get membership information.
- add `/membership/v1/subscription/{userId}`
- add `/membership/v1/list`
News:
https://developers.line.biz/en/news/2024/02/09/get-membership-plan-informations/- Loading branch information
Showing
2 changed files
with
296 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,295 @@ | ||
| --- | ||
| openapi: 3.0.0 | ||
| info: | ||
| title: Membership API | ||
| version: "0.0.1" | ||
| description: This document describes LINE Official Account Membership API. | ||
|
|
||
| servers: | ||
| - url: "https://api.line.me" | ||
|
|
||
| security: | ||
| - Bearer: [] | ||
|
|
||
| tags: | ||
| - name: membership | ||
|
|
||
| paths: | ||
| "/membership/v1/subscription/{userId}": | ||
| get: | ||
| externalDocs: | ||
| url: https://developers.line.biz/en/reference/messaging-api/#get-a-users-membership-subscription-status | ||
| tags: | ||
| - membership | ||
| operationId: getMembershipSubscription | ||
| description: "Get a user's membership subscription." | ||
| parameters: | ||
| - name: userId | ||
| in: path | ||
| required: true | ||
| schema: | ||
| type: string | ||
| description: "User ID" | ||
| responses: | ||
| "200": | ||
| description: "OK" | ||
| content: | ||
| application/json: | ||
| schema: | ||
| "$ref": "#/components/schemas/GetMembershipSubscriptionResponse" | ||
| example: | ||
| subscriptions: | ||
| - membership: | ||
| membershipId: 3189 | ||
| title: "Basic Plan" | ||
| description: "You will receive messages and photos every Saturday." | ||
| benefits: | ||
| - "Members Only Messages" | ||
| - "Members Only Photos" | ||
| price: 500.00 | ||
| currency: "JPY" | ||
| user: | ||
| membershipNo: 1 | ||
| joinedTime: 1707214784 | ||
| nextBillingDate: "2024-02-08" | ||
| totalSubscriptionMonths: 1 | ||
|
|
||
| "400": | ||
| description: "An invalid user ID is specified." | ||
| content: | ||
| application/json: | ||
| schema: | ||
| "$ref": "#/components/schemas/ErrorResponse" | ||
| "404": | ||
| description: "Unable to get information about the membership to which the user subscribes." | ||
| content: | ||
| application/json: | ||
| schema: | ||
| "$ref": "#/components/schemas/ErrorResponse" | ||
| "/membership/v1/list": | ||
| get: | ||
| externalDocs: | ||
| url: https://developers.line.biz/en/reference/messaging-api/#get-membership-plans | ||
| tags: | ||
| - membership | ||
| operationId: getMembershipList | ||
| description: "Get a list of memberships." | ||
| responses: | ||
| "200": | ||
| description: "OK" | ||
| content: | ||
| application/json: | ||
| schema: | ||
| "$ref": "#/components/schemas/MembershipListResponse" | ||
| example: | ||
| memberships: | ||
| - membershipId: 3189 | ||
| title: "Basic Plan" | ||
| description: "You will receive messages and photos every Saturday." | ||
| benefits: | ||
| - "Members Only Messages" | ||
| - "Members Only Photos" | ||
| price: 500.00 | ||
| currency: "JPY" | ||
| memberCount: 1 | ||
| memberLimit: null | ||
| isInAppPurchase: true | ||
| isPublished: true | ||
| - membershipId: 3213 | ||
| title: "Premium Plan" | ||
| description: "Invitation to a special party." | ||
| benefits: | ||
| - "Members Only Party" | ||
| price: 1500.00 | ||
| currency: "JPY" | ||
| memberCount: 0 | ||
| memberLimit: null | ||
| isInAppPurchase: false | ||
| isPublished: true | ||
| "404": | ||
| description: "Unable to get information about the memberships." | ||
| content: | ||
| application/json: | ||
| schema: | ||
| "$ref": "#/components/schemas/ErrorResponse" | ||
|
|
||
| components: | ||
| securitySchemes: | ||
| Bearer: | ||
| type: http | ||
| scheme: bearer | ||
| description: "Channel access token" | ||
|
|
||
| schemas: | ||
| GetMembershipSubscriptionResponse: | ||
| externalDocs: | ||
| url: https://developers.line.biz/en/reference/messaging-api/#get-a-users-membership-subscription-status | ||
| description: "A user's membership subscription status" | ||
| required: | ||
| - subscriptions | ||
| type: object | ||
| properties: | ||
| subscriptions: | ||
| type: array | ||
| minItems: 0 | ||
| description: "List of subscription information" | ||
| items: | ||
| "$ref": "#/components/schemas/Subscription" | ||
|
|
||
| MembershipListResponse: | ||
| description: "List of memberships" | ||
| required: | ||
| - memberships | ||
| type: object | ||
| properties: | ||
| memberships: | ||
| type: array | ||
| minItems: 0 | ||
| description: "List of membership information" | ||
| items: | ||
| "$ref": "#/components/schemas/Membership" | ||
|
|
||
| Subscription: | ||
| description: "An array of memberships." | ||
| required: | ||
| - membership | ||
| - user | ||
| type: object | ||
| properties: | ||
| membership: | ||
| "$ref": "#/components/schemas/MembershipMeta" | ||
| user: | ||
| "$ref": "#/components/schemas/MembershipUser" | ||
|
|
||
| MembershipMeta: | ||
| description: "Object containing information about the membership plan." | ||
| type: object | ||
| required: | ||
| - membershipId | ||
| - title | ||
| - description | ||
| - benefits | ||
| - price | ||
| - currency | ||
| properties: | ||
| membershipId: | ||
| type: integer | ||
| description: "Membership plan ID." | ||
| title: | ||
| type: string | ||
| description: "Membership plan name." | ||
| description: | ||
| type: string | ||
| description: "Membership plan description." | ||
| benefits: | ||
| type: array | ||
| minItems: 1 | ||
| items: | ||
| type: string | ||
| description: "List of membership plan perks." | ||
| price: | ||
| type: number | ||
| format: double | ||
| example: 500.00 | ||
| description: "Monthly fee for membership plan. (e.g. 1500.00)" | ||
| currency: | ||
| type: string | ||
| description: "The currency of membership.price." | ||
| enum: | ||
| - JPY | ||
| - TWD | ||
| - THB | ||
|
|
||
| MembershipUser: | ||
| description: "Object containing user membership subscription information." | ||
| type: object | ||
| required: | ||
| - membershipNo | ||
| - joinedTime | ||
| - nextBillingDate | ||
| - totalSubscriptionMonths | ||
| properties: | ||
| membershipNo: | ||
| type: integer | ||
| description: "The user's member number in the membership plan." | ||
| joinedTime: | ||
| type: integer | ||
| description: "UNIX timestamp at which the user subscribed to the membership." | ||
| nextBillingDate: | ||
| type: string | ||
| description: | | ||
| Next payment date for membership plan. | ||
| - Format: yyyy-MM-dd (e.g. 2024-02-08) | ||
| - Timezone: UTC+9 | ||
| totalSubscriptionMonths: | ||
| type: integer | ||
| description: "The period of time in months that the user has been subscribed to a membership plan. If a user previously canceled and then re-subscribed to the same membership plan, only the period after the re-subscription will be counted." | ||
|
|
||
| Membership: | ||
| required: | ||
| - membershipId | ||
| - title | ||
| - description | ||
| - benefits | ||
| - price | ||
| - currency | ||
| - memberCount | ||
| - memberLimit | ||
| - isInAppPurchase | ||
| - isPublished | ||
| type: object | ||
| properties: | ||
| membershipId: | ||
| type: integer | ||
| description: "Membership plan ID." | ||
| title: | ||
| type: string | ||
| description: "Membership plan name." | ||
| description: | ||
| type: string | ||
| description: "Membership plan description." | ||
| benefits: | ||
| type: array | ||
| minItems: 1 | ||
| items: | ||
| type: string | ||
| description: "List of membership plan perks." | ||
| price: | ||
| type: number | ||
| format: double | ||
| example: 500.00 | ||
| description: "Monthly fee for membership plan. (e.g. 1500.00)" | ||
| currency: | ||
| type: string | ||
| description: "The currency of membership.price." | ||
| enum: | ||
| - JPY | ||
| - TWD | ||
| - THB | ||
| memberCount: | ||
| type: integer | ||
| example: 100 | ||
| description: "Number of members subscribed to the membership plan." | ||
| memberLimit: | ||
| type: integer | ||
| nullable: true | ||
| example: 1000 | ||
| description: "The upper limit of members who can subscribe. If no upper limit is set, it will be null." | ||
| isInAppPurchase: | ||
| type: boolean | ||
| description: "Payment method for users who subscribe to a membership plan." | ||
| isPublished: | ||
| type: boolean | ||
| description: "Membership plan status." | ||
| ErrorResponse: | ||
| required: | ||
| - message | ||
| type: object | ||
| properties: | ||
| message: | ||
| type: string | ||
| description: "Error message" | ||
| details: | ||
| type: array | ||
| items: | ||
| type: string |